{"info":{"version":"3.2.0.0.0","description":"VMware NSX-T Manager REST API","title":"NSX-T Manager API"},"schemes":["https"],"produces":["application/json"],"securityDefinitions":{"BasicAuth":{"type":"basic","description":"HTTP Basic Authentication"}},"host":"nsxmanager.your.domain","security":[{"BasicAuth":[]}],"swagger":"2.0","basePath":"/api/v1","paths":{"/serviceinsertion/services/{service-id}/service-profiles/{service-profile-id}/nsgroups":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ServiceProfileNSGroups"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns list of NSGroups used in Service Insertion rules for a given Service Profile.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"required":true,"type":"string","name":"service-profile-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Get NSgroups for a given ServiceProfile.","x-vmw-nsx-module":"ServiceInsertion","consumes":["application/json"],"operationId":"GetServiceProfileNSGroups"}},"/serviceinsertion/sections/{section-id}/rules":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ServiceInsertionRule"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"description":"Bad Request"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Adds a new serviceinsertion rule in existing serviceinsertion section.\nNote- POST service insertion section API is deprecated.\nPlease use policy redirection-policy API.\n","parameters":[{"required":true,"type":"string","name":"section-id","in":"path"},{"schema":{"$ref":"#/definitions/ServiceInsertionRule"},"required":true,"name":"ServiceInsertionRule","in":"body"},{"in":"query","description":"Identifier of the anchor rule or section. This is a required field in case operation like 'insert_before' and 'insert_after'.","required":false,"maxLength":64,"type":"string","name":"id"},{"enum":["insert_top","insert_bottom","insert_after","insert_before"],"description":"Operation","default":"insert_top","required":false,"in":"query","type":"string","name":"operation"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Add a Single Rule in a Section","x-vmw-nsx-module":"ServiceInsertionRules","consumes":["application/json"],"operationId":"AddServiceInsertionRuleInSection"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ServiceInsertionRuleListResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Return all serviceinsertion rule(s) information for a given serviceinsertion section.\nNote- GET service insertion rules API is deprecated.\nPlease use policy redirection-policy API.\n","parameters":[{"required":true,"type":"string","name":"section-id","in":"path"},{"description":"AppliedTo's referenced by this section or section's Distributed Service Rules .","required":false,"type":"string","name":"applied_tos","in":"query"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Destinations referenced by this section's Distributed Service Rules .","required":false,"type":"string","name":"destinations","in":"query"},{"enum":["FILTER","SEARCH"],"description":"Filter type","default":"FILTER","required":false,"in":"query","type":"string","name":"filter_type"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"description":"NSService referenced by this section's Distributed Service Rules .","required":false,"type":"string","name":"services","in":"query"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"description":"Sources referenced by this section's Distributed Service Rules .","required":false,"type":"string","name":"sources","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Get All the Rules for a Section","x-vmw-nsx-module":"ServiceInsertionRules","consumes":["application/json"],"operationId":"GetServiceInsertionRules"}},"/node/services/install-upgrade?action=start":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"409":{"description":"Conflict"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the NSX install-upgrade service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Install Upgrade Service"],"summary":"Restart, start or stop the NSX install-upgrade service","x-vmw-nsx-module":"NodeInstallUpgradeService","consumes":["application/json"],"operationId":"CreateRepositoryServiceActionStart"}},"/logical-switches/{lswitch-id}/vtep-table":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/VtepListResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the virtual tunnel endpoint table of a specified logical switch\nfrom the given transport node if a transport node id is given in the\nquery parameter, from the Central Controller Plane.\nThe query parameter \"source=cached\" is not supported.\n","parameters":[{"required":true,"type":"string","name":"lswitch-id","in":"path"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"},{"description":"TransportNode Id","required":false,"type":"string","name":"transport_node_id","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Switching","Logical Switches"],"summary":"Get virtual tunnel endpoint table for logical switch of the given\nID (lswitch-id)\n","x-vmw-nsx-module":"AggSvcLogicalSwitch","consumes":["application/json"],"operationId":"GetLogicalSwitchVtepTable"}},"/idfw/master-switch-setting":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IdfwMasterSwitchSetting"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"description":"Bad Request"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update Identity Firewall master switch setting (true=enabled / false=disabled).\nIdentity Firewall master switch setting enables or disables Identity Firewall\nfeature across the system. It affects compute collections, hypervisor and\nvirtual machines. This operation is expensive and also has big impact and\nimplication on system perforamce.\n","parameters":[{"schema":{"$ref":"#/definitions/IdfwMasterSwitchSetting"},"required":true,"name":"IdfwMasterSwitchSetting","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Security","Identity Firewall","Configuration"],"summary":"Update IDFW master switch setting enabled/disabled","x-vmw-nsx-module":"IdentityFirewall","consumes":["application/json"],"operationId":"UpdateMasterSwitchSetting"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IdfwMasterSwitchSetting"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Fetches IDFW master switch setting to check whether master switch is enabled\nor disabled\n","produces":["application/json"],"tags":["Management Plane API","Security","Identity Firewall","Configuration"],"summary":"Get Identity Firewall master switch enabled/disabled","x-vmw-nsx-module":"IdentityFirewall","consumes":["application/json"],"operationId":"GetMasterSwitchSetting"}},"/mac-sets/{mac-set-id}/members/{mac-address}":{"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Remove an individual MAC address from a MACSet\n","parameters":[{"description":"MACSet Id","required":true,"type":"string","name":"mac-set-id","in":"path"},{"description":"MAC address to be removed","required":true,"type":"string","name":"mac-address","in":"path"}],"tags":["Management Plane API","Grouping Objects","MAC Sets"],"summary":"Remove a MAC address from given MACSet","x-vmw-nsx-module":"MACSet","consumes":["application/json"],"operationId":"RemoveMACAddress"}},"/dhcp/server-profiles/{server-profile-id}?action=reallocate":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DhcpProfile"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"As changing edge-cluster-id of a DhcpProfile by a PUT is disallowed,\nthis re-allocate API is used to modify the edge-cluster-id and members\nof a given DhcpProfile.\n\nOnly the edge-cluster-id and the edge-cluster-member-indexes fields will\nbe picked up by this re-allication API. The othere fields in the payload\nwill be ignored.\n\nIf the edge-cluster-id in the payload DhcpProfile is different from the\ncurrent edge-cluster-id of the profile, the referencing DHCP server(s) will\nbe re-allocated to the new edge cluster. If the edge-cluster-id is not\nchanged, the referencing DHCP server(s) will be re-allocated to the\ngiven edge members in the edge cluster. In this case, this REST API will\nact same as that of updating a DhcpProfile.\n\nIf the edge cluster member indexes are provided, they should exist in the\ngiven edge cluster. If the indexes are not specified in the DhcpProfile,\nedge members will be auto-allocated from the given edge cluster.\n\nPlease note that re-allocating edge-cluster will cause lose of all exisitng\nDHCP lease information. This API is used only when loosing DHCP leases is\nnot a real problem, e.g. cross-site migration or failover and all client\nhosts will be reboot and get new IP addresses.\n","parameters":[{"required":true,"type":"string","name":"server-profile-id","in":"path"},{"schema":{"$ref":"#/definitions/DhcpProfile"},"required":true,"name":"DhcpProfile","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","DHCP"],"summary":"Reallocate edge cluster and members of given DHCP profile.","x-vmw-nsx-module":"Dhcp","consumes":["application/json"],"operationId":"ReallocateDhcpProfileEdgeCluster"}},"/eula/acceptance":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EULAAcceptance"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Return the acceptance status of end user license agreement\n","produces":["application/json"],"tags":["System Administration","Settings","Licenses"],"summary":"Return the acceptance status of end user license agreement\n","x-vmw-nsx-module":"EULA","consumes":["application/json"],"operationId":"GetEULAAcceptance"}},"/vpn/ipsec/services/{ipsec-vpn-service-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IPSecVPNService"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Edit IPSec VPN service for given logical router.","parameters":[{"required":true,"type":"string","name":"ipsec-vpn-service-id","in":"path"},{"schema":{"$ref":"#/definitions/IPSecVPNService"},"required":true,"name":"IPSecVPNService","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","VPN","IPSEC","Services"],"summary":"Edit IPSec VPN service","x-vmw-nsx-module":"IPSecVPN","consumes":["application/json"],"operationId":"UpdateIPSecVPNService"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IPSecVPNService"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get IPSec VPN service for given logical router.","parameters":[{"required":true,"type":"string","name":"ipsec-vpn-service-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","VPN","IPSEC","Services"],"summary":"Get IPSec VPN service","x-vmw-nsx-module":"IPSecVPN","consumes":["application/json"],"operationId":"GetIPSecVPNService"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete IPSec VPN service for given router.","parameters":[{"required":true,"type":"string","name":"ipsec-vpn-service-id","in":"path"},{"default":false,"description":"Force delete the resource even if it is being used somewhere\n","type":"boolean","name":"force","in":"query"}],"tags":["Management Plane API","Networking","VPN","IPSEC","Services"],"summary":"Delete IPSec VPN service","x-vmw-nsx-module":"IPSecVPN","consumes":["application/json"],"operationId":"DeleteIPSecVPNService"}},"/serviceinsertion/services/{service-id}/service-instances/{service-instance-id}/group-associations":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ServiceInstanceNSGroups"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns list of NSGroups used in Service Insertion North-South rules for a given\nService Instance.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"required":true,"type":"string","name":"service-instance-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Get NSgroups for a given ServiceInstance.","x-vmw-nsx-module":"ServiceInsertion","consumes":["application/json"],"operationId":"GetServiceInstanceNSGroups"}},"/logical-routers/{logical-router-id}/routing/static-routes":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/StaticRoute"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Adds a new static route on a Logical Router\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"schema":{"$ref":"#/definitions/StaticRoute"},"required":true,"name":"StaticRoute","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Routing Configuration"],"summary":"Add Static Routes on a Logical Router","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"AddStaticRoute"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/StaticRouteListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about configured static routes, including the\nnetwork address and next hops for each static route.\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Routing Configuration"],"summary":"Paginated List of Static Routes","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"ListStaticRoutes"}},"/cluster/nodes/{node-id}/network/interfaces":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeInterfacePropertiesListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the number of interfaces on the node and detailed\ninformation about each interface. Interface information includes MTU,\nbroadcast and host IP addresses, link and admin status, MAC address, network\nmask, and the IP configuration method (static or DHCP).\n","parameters":[{"required":true,"type":"string","name":"node-id","in":"path"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"}],"produces":["application/json"],"tags":["System Administration","Configuration","NSX Managers","Clusters","Cluster Interfaces"],"summary":"List the specified node's Network Interfaces","x-vmw-nsx-module":"ApplianceStats","consumes":["application/json"],"operationId":"ListClusterNodeInterfaces"}},"/node/services/syslog/exporters":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/NodeSyslogExporterProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"409":{"description":"Conflict"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Adds a rule for exporting syslog information to a specified server. The\nrequired parameters are the rule name (exporter_name); severity level\n(emerg, alert, crit, and so on); transmission protocol (TCP or UDP); and\nserver IP address or hostname. The optional parameters are the syslog port\nnumber, which can be 1 through 65,535 (514, by default); facility level to\nuse when logging messages to syslog (kern, user, mail, and so on); and\nmessage IDs (msgids), which identify the types of messages to export.\n","parameters":[{"schema":{"$ref":"#/definitions/NodeSyslogExporterProperties"},"required":true,"name":"NodeSyslogExporterProperties","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","Syslog"],"summary":"Add node syslog exporter","x-vmw-nsx-module":"NodeSyslogExporters","consumes":["application/json"],"operationId":"PostNodeSyslogExporter"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeSyslogExporterPropertiesListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the collection of registered syslog exporter rules, if any. The\nrules specify the collector IP address and port, and the protocol to use.\n","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","Syslog"],"summary":"List node syslog exporters","x-vmw-nsx-module":"NodeSyslogExporters","consumes":["application/json"],"operationId":"ListNodeSyslogExporters"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Removes all syslog exporter rules.\n","tags":["System Administration","Configuration","Fabric","Nodes","Services","Syslog"],"summary":"Delete all node syslog exporters","x-vmw-nsx-module":"NodeSyslogExporters","consumes":["application/json"],"operationId":"DeleteNodeSyslogExporterAll"}},"/node/services/nsx-platform-client?action=restart":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the NSX Platform Client service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","NSX Platform Client"],"summary":"Restart, start or stop the NSX Platform Client service","x-vmw-nsx-module":"NodePlatformClientService","consumes":["application/json"],"operationId":"CreatePlatformClientServiceActionRestart"}},"/upgrade/nodes-summary":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeSummaryList"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get summary of nodes, which includes node count for each type and component version.","produces":["application/json"],"tags":["System Administration","Lifecycle Management","Upgrade","Nodes"],"summary":"Get summary of nodes","x-vmw-nsx-module":"Upgrade","consumes":["application/json"],"operationId":"GetNodesSummary"}},"/traceflows/{traceflow-id}":{"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete the Traceflow round","parameters":[{"required":true,"type":"string","name":"traceflow-id","in":"path"}],"tags":["Management Plane API","Troubleshooting And Monitoring","Traceflow"],"summary":"Delete the Traceflow round","x-vmw-nsx-module":"Traceflow","consumes":["application/json"],"operationId":"DeleteTraceflow"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Traceflow"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get the Traceflow round status and result summary","parameters":[{"required":true,"type":"string","name":"traceflow-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Troubleshooting And Monitoring","Traceflow"],"summary":"Get the Traceflow round status and result summary","x-vmw-nsx-module":"Traceflow","consumes":["application/json"],"operationId":"GetTraceflow"}},"/vpn/l2vpn/sessions/summary":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/L2VPNSessionSummary"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Load all the existing L2VPN sessions and return the status summary of all L2VPN sessions. Query parameter source supports only cached mode.","parameters":[{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"}],"produces":["application/json"],"tags":["Management Plane API","Networking","VPN","Statistics","L2VPN Sessions Summary"],"summary":"Get status summary of all existing L2VPN sessions.","x-vmw-nsx-module":"L2VPNStatistics","consumes":["application/json"],"operationId":"GetL2VPNSessionSummary"}},"/node/services/cm-inventory?action=stop":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the manager service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Cm Inventory Service"],"summary":"Restart, start or stop the manager service","x-vmw-nsx-module":"NodeCminventoryService","consumes":["application/json"],"operationId":"CreateCminventoryServiceActionStop"}},"/serviceinsertion/services/{service-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ServiceDefinition"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Modifies the specified Service.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"schema":{"$ref":"#/definitions/ServiceDefinition"},"required":true,"name":"ServiceDefinition","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Update an existing Service","x-vmw-nsx-module":"ServiceInsertion","consumes":["application/json"],"operationId":"UpdateServiceInsertionService"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ServiceDefinition"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about Service-Insertion Service with the given identifier.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Get an existing Service","x-vmw-nsx-module":"ServiceInsertion","consumes":["application/json"],"operationId":"GetServiceInsertionService"},"delete":{"responses":{"200":{"description":"OK"},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Removes Service-Insertion Service from the system. A Service with\nService-Instances can only be deleted by passing \"cascade=true\" parameter.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"description":"Flag to cascade delete all the child objects, associated with it.","default":false,"required":false,"in":"query","type":"boolean","name":"cascade"}],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Delete an existing Service and the Service-Instance associated with it.","x-vmw-nsx-module":"ServiceInsertion","consumes":["application/json"],"operationId":"DeleteServiceInsertionService"}},"/logical-routers":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/LogicalRouter"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Creates a logical router. The required parameters are router_type (TIER0 or\nTIER1) and edge_cluster_id (TIER0 only). Optional parameters include\ninternal and external transit network addresses.\n","parameters":[{"schema":{"$ref":"#/definitions/LogicalRouter"},"required":true,"name":"LogicalRouter","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Logical Routers"],"summary":"Create a Logical Router","x-vmw-nsx-module":"LogicalRouter","consumes":["application/json"],"operationId":"CreateLogicalRouter"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LogicalRouterListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about all logical routers, including the UUID, internal\nand external transit network addresses, and the router type (TIER0 or\nTIER1). You can get information for only TIER0 routers or only the TIER1\nrouters by including the router_type query parameter.\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"enum":["TIER0","TIER1","VRF"],"description":"Type of Logical Router","required":false,"in":"query","type":"string","name":"router_type"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"description":"List all VRFs on the specified logical router.","required":false,"type":"string","name":"vrfs_on_logical_router_id","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Logical Routers"],"summary":"List Logical Routers","x-vmw-nsx-module":"LogicalRouter","consumes":["application/json"],"operationId":"ListLogicalRouters"}},"/logical-routers/{logical-router-id}/routing/forwarding-table":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LogicalRouterRouteTable"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the FIB for the logical router on a node of the given transport-node-id.\nQuery parameter \"transport_node_id=<transport-node-id>\" is required.\nTo filter the result by network address, paramter \"network_prefix=<a.b.c.d/mask>\"\nneeds to be specified.\nQuery parameter \"source=realtime\" is the only supported source.\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"IPv4 or IPv6 CIDR Block","format":"ip-cidr-block","required":false,"in":"query","type":"string","name":"network_prefix"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"},{"description":"TransportNode Id","required":true,"type":"string","name":"transport_node_id","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Logical Routers"],"summary":"Get FIB table on a specified node for a logical router","x-vmw-nsx-module":"AggSvcLogicalRouter","consumes":["application/json"],"operationId":"GetLogicalRouterForwardingTable"}},"/logical-switches/{lswitch-id}/statistics":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LogicalSwitchStatistics"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns statistics of a specified logical switch.\nThe query parameter \"source=realtime\" is not supported.\n","parameters":[{"required":true,"type":"string","name":"lswitch-id","in":"path"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Switching","Logical Switches"],"summary":"Get Statistics for Logical Switch of the Given ID (lswitch-id)","x-vmw-nsx-module":"AggSvcLogicalSwitch","consumes":["application/json"],"operationId":"GetLogicalSwitchStatistics"}},"/logical-routers/{logical-router-id}/routing/route-maps":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RouteMap"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Adds a new RouteMap on a Logical Router\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"schema":{"$ref":"#/definitions/RouteMap"},"required":true,"name":"RouteMap","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Routing Configuration"],"summary":"Add RouteMap on a Logical Router","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"AddRouteMap"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RouteMapListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Paginated List of RouteMaps","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Routing Configuration"],"summary":"Paginated List of RouteMaps","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"ListRouteMaps"}},"/cluster/api-certificate?action=set_cluster_certificate":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ClusterCertificateId"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Sets the certificate used for the MP cluster.\nThis affects all nodes in the cluster. If the certificate used is a CA signed\ncertificate,the request fails if the whole chain(leaf, intermediate, root)\nis not imported.\n","parameters":[{"description":"Certificate ID","required":true,"type":"string","name":"certificate_id","in":"query"}],"produces":["application/json"],"tags":["System Administration","Configuration","NSX Managers","Clusters","Cluster Certificate"],"summary":"Set the cluster certificate","x-vmw-nsx-module":"ClusterCertificate","consumes":["application/json"],"operationId":"SetClusterCertificateSetClusterCertificate"}},"/cluster/restore?action=retry":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ClusterRestoreStatus"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"500":{"$ref":"#/responses/InternalServerError"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ClusterRestoreStatus"}}},"description":"Retry any currently in-progress, failed restore operation. Only the last\nstep of the multi-step restore operation would have failed,and only that\nstep is retried. This operation is only valid when a\nGET cluster/restore/status returns a status with value FAILED. Otherwise,\na 409 response is returned.\n","produces":["application/json"],"tags":["System Administration","Lifecycle Management","Backup Restore Management","Restore"],"summary":"Retry any failed restore operation","x-vmw-nsx-module":"ClusterRestore","consumes":["application/json"],"operationId":"RetryClusterRestore"}},"/node/network":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeNetworkProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read network configuration properties","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Network Interfaces"],"summary":"Read network configuration properties","x-vmw-nsx-module":"NodeNetworkModule","consumes":["application/json"],"operationId":"ReadNetworkProperties"}},"/dhcp/servers/{server-id}/ip-pools":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/DhcpIpPool"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Create an ip pool for a local DHCP server","parameters":[{"required":true,"type":"string","name":"server-id","in":"path"},{"schema":{"$ref":"#/definitions/DhcpIpPool"},"required":true,"name":"DhcpIpPool","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","DHCP"],"summary":"Create an ip pool for a DHCP server","x-vmw-nsx-module":"Dhcp","consumes":["application/json"],"operationId":"CreateDhcpIpPool"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DhcpIpPoolListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"List the ip pools of a logical DHCP server with pagination support.\n","parameters":[{"required":true,"type":"string","name":"server-id","in":"path"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","DHCP"],"summary":"Get a paginated list of a DHCP server's IP pools","x-vmw-nsx-module":"Dhcp","consumes":["application/json"],"operationId":"ListDhcpIpPools"}},"/cluster/nodes/{node-id}/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ClusterNodeStatus"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read aggregated runtime status of cluster node.\n","parameters":[{"required":true,"type":"string","name":"node-id","in":"path"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"}],"produces":["application/json"],"tags":["System Administration","Configuration","NSX Managers","Clusters","Cluster Status"],"summary":"Read cluster node runtime status","x-vmw-nsx-module":"ClusterManagement","consumes":["application/json"],"operationId":"ReadClusterNodeStatus"}},"/sites":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FederationConfiguration"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"description":"Service Unavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get the site configuration","produces":["application/json"],"tags":["System Administration","Configuration","Site Management"],"summary":"Get the site configuration","x-vmw-nsx-module":"SiteManagerModule","consumes":["application/json"],"operationId":"GetSiteConfiguration"}},"/dns/forwarders/{forwarder-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DnsForwarder"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update a specific DNS forwarder.\n","parameters":[{"required":true,"type":"string","name":"forwarder-id","in":"path"},{"schema":{"$ref":"#/definitions/DnsForwarder"},"required":true,"name":"DnsForwarder","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","DNS"],"summary":"Update a specific DNS forwarder","x-vmw-nsx-module":"DnsForwarder","consumes":["application/json"],"operationId":"UpdateDnsForwarder"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DnsForwarder"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Retrieve a DNS forwarder.\n","parameters":[{"required":true,"type":"string","name":"forwarder-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","DNS"],"summary":"Retrieve a DNS forwarder","x-vmw-nsx-module":"DnsForwarder","consumes":["application/json"],"operationId":"ReadDnsForwader"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete a specific DNS forwarder.\n","parameters":[{"required":true,"type":"string","name":"forwarder-id","in":"path"}],"tags":["Management Plane API","Networking","Services","DNS"],"summary":"Delete a specific DNS forwarder","x-vmw-nsx-module":"DnsForwarder","consumes":["application/json"],"operationId":"DeleteDnsForwarder"}},"/nvds-urt/precheck":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NvdsUpgradePrecheckId"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Start precheck for N-VDS to VDS migration","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Transport Nodes"],"summary":"Start precheck for N-VDS to VDS migration","x-vmw-nsx-module":"NvdsUpgradeReadinessCheck","consumes":["application/json"],"operationId":"CreateNvdsUpgradePrecheck"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NvdsUpgradePrecheckId"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Retrieve latest precheck ID of the N-VDS to VDS migration","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Transport Nodes"],"summary":"Retrieve latest precheck ID of the N-VDS to VDS migration","x-vmw-nsx-module":"NvdsUpgradeReadinessCheck","consumes":["application/json"],"operationId":"GetNvdsUpgradePrecheckId"}},"/upgrade/plan?action=start":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Start the upgrade. Upgrade will start as per the upgrade plan.\n","tags":["System Administration","Lifecycle Management","Upgrade","Plan"],"summary":"Start upgrade","x-vmw-nsx-module":"Upgrade","consumes":["application/json"],"operationId":"StartUpgrade"}},"/firewall/rules/{rule-id}":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FirewallRule"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Return existing firewall rule information.\n","parameters":[{"required":true,"type":"string","name":"rule-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Firewall"],"summary":"Read an Existing Rule","x-vmw-nsx-module":"Firewall","consumes":["application/json"],"operationId":"ReadFirewallRule"}},"/pools/vtep-label-pools/{pool-id}":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/VtepLabelPool"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about the specified virtual tunnel endpoint label pool.\n","parameters":[{"description":"Virtual tunnel endpoint label pool ID","required":true,"type":"string","name":"pool-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Pool Management","VTEP Label Pools"],"summary":"Read a virtual tunnel endpoint label pool","x-vmw-nsx-module":"VtepLabel","consumes":["application/json"],"operationId":"ReadVtepLabelPool"}},"/logical-routers/{logical-router-id}/nat/rules/{rule-id}/statistics":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NatStatisticsPerRule"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the summation of statistics from all nodes for the Specified\nLogical Router NAT Rule. Query parameter \"source=realtime\" is the only supported source.\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"required":true,"type":"string","name":"rule-id","in":"path"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","NAT"],"summary":"Get the statistics of a specified logical router NAT Rule","x-vmw-nsx-module":"AggSvcLogicalRouter","consumes":["application/json"],"operationId":"GetNatStatisticsPerRule"}},"/node/services/search?action=stop":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the NSX Search service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Search Service"],"summary":"Restart, start or stop the NSX Search service","x-vmw-nsx-module":"NodeSearchService","consumes":["application/json"],"operationId":"CreateSearchServiceActionStop"}},"/dhcp/server-profiles":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/DhcpProfile"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Create a DHCP server profile. If no edge member is specified, edge members\nto run the dhcp servers will be auto-allocated from the edge cluster.\n","parameters":[{"schema":{"$ref":"#/definitions/DhcpProfile"},"required":true,"name":"DhcpProfile","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","DHCP"],"summary":"Create a DHCP server profile","x-vmw-nsx-module":"Dhcp","consumes":["application/json"],"operationId":"CreateDhcpProfile"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DhcpProfileListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get a paginated list of DHCP server profiles.","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","DHCP"],"summary":"Get a paginated list of DHCP server profiles","x-vmw-nsx-module":"Dhcp","consumes":["application/json"],"operationId":"ListDhcpProfiles"}},"/node/services/policy?action=stop":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Policy Service"],"summary":"Restart, start or stop the service","x-vmw-nsx-module":"NodePolicyService","consumes":["application/json"],"operationId":"CreatePolicyServiceActionStop"}},"/migration/logical-constructs/stats":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LogicalConstructMigrationStatsListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get migration stats for logical constructs phase. This API can be polled for getting runtime progress of the migration from source to target.","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Migration","Stats"],"summary":"Get migration stats for logical constructs phase","x-vmw-nsx-module":"Migration","consumes":["application/json"],"operationId":"GetLogicalConstructMigrationStats"}},"/idfw/idfw-compute-collections/{cc-ext-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IdfwEnabledComputeCollection"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Enable/disable individual compute collections for IDFW.\n","parameters":[{"required":true,"type":"string","name":"cc-ext-id","in":"path"},{"schema":{"$ref":"#/definitions/IdfwEnabledComputeCollection"},"required":true,"name":"IdfwEnabledComputeCollection","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Security","Identity Firewall","Configuration"],"summary":"Update IDFW compute collection","x-vmw-nsx-module":"IdentityFirewall","consumes":["application/json"],"operationId":"UpdateEnabledComputeCollection"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IdfwEnabledComputeCollection"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get enable/disable status of individual compute collections for IDFW.\n","parameters":[{"required":true,"type":"string","name":"cc-ext-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Security","Identity Firewall","Configuration"],"summary":"Get IDFW compute collection.","x-vmw-nsx-module":"IdentityFirewall","consumes":["application/json"],"operationId":"GetEnabledComputeCollection"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete individual compute collections for IDFW.\n","parameters":[{"required":true,"type":"string","name":"cc-ext-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Security","Identity Firewall","Configuration"],"summary":"Delete IDFW compute collection.","x-vmw-nsx-module":"IdentityFirewall","consumes":["application/json"],"operationId":"DeleteEnabledComputeCollection"}},"/logical-routers/{logical-router-id}/routing/route-table?format=csv":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LogicalRouterRouteTableInCsvFormat"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Deprecated - Please use /logical-routers/<logical-router-id>/routing/routing-table for RIB and\n/logical-routers/<logical-router-id>/routing/forwarding-table for FIB.\nReturns the route table in CSV format for the logical router on a node of the given\ntransport-node-id. Query parameter \"transport_node_id=<transport-node-id>\" is required.\nQuery parameter \"source=realtime\" is the only supported source.\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"},{"description":"TransportNode Id","required":true,"type":"string","name":"transport_node_id","in":"query"}],"produces":["text/csv"],"tags":["Management Plane API","Networking","Logical Routing And Services","Logical Routers"],"summary":"Get route table on a node for a logical router","x-vmw-nsx-module":"AggSvcLogicalRouter","consumes":["application/json"],"operationId":"GetLogicalRouterRouteTableInCsvFormat"}},"/upgrade/plan?action=pause":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"409":{"description":"Conflict"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Pause the upgrade. Upgrade will be paused after upgrade of all\nthe nodes currently in progress is completed either successfully\nor with failure. User can make changes in the upgrade plan when\nthe upgrade is paused.\n","tags":["System Administration","Lifecycle Management","Upgrade","Plan"],"summary":"Pause upgrade","x-vmw-nsx-module":"Upgrade","consumes":["application/json"],"operationId":"PauseUpgrade"}},"/fabric/physical-servers/{physical-server-id}":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PhysicalServer"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about physical/bare metal server based on given transport node id.","parameters":[{"required":true,"type":"string","name":"physical-server-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Physical Servers"],"summary":"Return a specific physical server","x-vmw-nsx-module":"PhysicalServer","consumes":["application/json"],"operationId":"GetPhysicalServer"}},"/ns-services/{ns-service-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NSService"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"409":{"description":"Conflict"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Updates the specified NSService. Modifiable parameters include the description,\ndisplay_name and the NSService element. The system defined NSServices can't be\nmodified\n","parameters":[{"description":"NSService Id","required":true,"type":"string","name":"ns-service-id","in":"path"},{"schema":{"$ref":"#/definitions/NSService"},"required":true,"name":"NSService","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Grouping Objects","NS Services"],"summary":"Update NSService","x-vmw-nsx-module":"NSService","consumes":["application/json"],"operationId":"UpdateNSService"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"409":{"description":"Conflict"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Deletes the specified NSService. By default, if the NSService is being\nreferred in an NSServiceGroup, it can't be deleted. In such situations,\npass \"force=true\" as a parameter to force delete the NSService. System\ndefined NSServices can't be deleted using \"force\" flag.\n","parameters":[{"description":"NSService Id","required":true,"type":"string","name":"ns-service-id","in":"path"},{"default":false,"description":"Force delete the resource even if it is being used somewhere\n","type":"boolean","name":"force","in":"query"}],"tags":["Management Plane API","Grouping Objects","NS Services"],"summary":"Delete NSService","x-vmw-nsx-module":"NSService","consumes":["application/json"],"operationId":"DeleteNSService"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NSService"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about the specified NSService\n","parameters":[{"description":"NSService Id","required":true,"type":"string","name":"ns-service-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Grouping Objects","NS Services"],"summary":"Read NSService","x-vmw-nsx-module":"NSService","consumes":["application/json"],"operationId":"ReadNSService"}},"/aaa/roles/{role}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RoleWithFeatures"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Creates a new role with id as <role> if there does not exist any\nrole with id <role>, else updates the existing role.\n","parameters":[{"description":"Custom role id","required":true,"type":"string","name":"role","in":"path"},{"schema":{"$ref":"#/definitions/RoleWithFeatures"},"required":true,"name":"RoleWithFeatures","in":"body"}],"produces":["application/json"],"tags":["System Administration","Settings","User Management","Roles"],"summary":"Update custom role","x-vmw-nsx-module":"AAA","consumes":["application/json"],"operationId":"CreateOrUpdateRole"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"If a role is assigned to a role binding then the deletion of\nthe role is not allowed. Precanned roles cannot be deleted.\n","parameters":[{"description":"Custom role id","required":true,"type":"string","name":"role","in":"path"}],"tags":["System Administration","Settings","User Management","Roles"],"summary":"Delete custom role","x-vmw-nsx-module":"AAA","consumes":["application/json"],"operationId":"DeleteRole"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RoleWithFeatures"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get role information","parameters":[{"description":"Role id","required":true,"type":"string","name":"role","in":"path"}],"produces":["application/json"],"tags":["System Administration","Settings","User Management","Roles"],"summary":"Get role information","x-vmw-nsx-module":"AAA","consumes":["application/json"],"operationId":"GetRoleInfo"}},"/cluster/nodes":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/ClusterNodeConfig"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Add a new controller to the NSX cluster.\nDeprecated. Use POST /cluster?action=join_cluster to join a node to cluster.\nThe controller comes with the new node.\n","parameters":[{"schema":{"$ref":"#/definitions/AddClusterNodeSpec"},"required":true,"name":"AddClusterNodeSpec","in":"body"},{"required":true,"type":"string","name":"action","enum":["add_cluster_node"],"in":"query"}],"produces":["application/json"],"tags":["System Administration","Configuration","NSX Managers","Clusters","Cluster Configuration"],"summary":"Add a controller to the cluster","x-vmw-nsx-module":"ClusterManagement","consumes":["application/json"],"operationId":"AddClusterNode"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ClusterNodeConfigListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about all NSX cluster nodes.\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["System Administration","Configuration","NSX Managers","Clusters","Cluster Configuration"],"summary":"List Cluster Node Configurations","x-vmw-nsx-module":"ClusterManagement","consumes":["application/json"],"operationId":"ListClusterNodeConfigs"}},"/ui-views/{view-id}/widgetconfigurations":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/WidgetConfiguration"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Creates a new Widget Configuration and adds it to the specified view.\nSupported resource_types are LabelValueConfiguration, DonutConfiguration,\nGridConfiguration, StatsConfiguration, MultiWidgetConfiguration,\nGraphConfiguration and ContainerConfiguration.\n\nNote: Expressions should be given in a single line. If an expression spans\n multiple lines, then form the expression in a single line.\nFor label-value pairs, expressions are evaluated as follows:\n a. First, render configurations are evaluated in their order of\n appearance in the widget config. The 'field' is evaluated at the end.\n b. Second, when render configuration is provided then the order of\n evaluation is\n 1. If expressions provided in 'condition' and 'display value' are\n well-formed and free of runtime-errors such as 'null pointers' and\n evaluates to 'true'; Then remaining render configurations are not\n evaluated, and the current render configuration's 'display value'\n is taken as the final value.\n 2. If expression provided in 'condition' of render configuration is\n false, then next render configuration is evaluated.\n 3. Finally, 'field' is evaluated only when every render configuration\n evaluates to false and no error occurs during steps 1 and 2 above.\n\nIf an error occurs during evaluation of render configuration, then an\n error message is shown. The display value corresponding to that label is\n not shown and evaluation of the remaining render configurations continues\n to collect and show all the error messages (marked with the 'Label' for\n identification) as 'Error_Messages: {}'.\n\nIf during evaluation of expressions for any label-value pair an error\n occurs, then it is marked with error. The errors are shown in the report,\n along with the label value pairs that are error-free.\n\nImportant: For elements that take expressions, strings should be provided\n by escaping them with a back-slash. These elements are - condition, field,\n tooltip text and render_configuration's display_value.\n","parameters":[{"required":true,"type":"string","name":"view-id","in":"path"},{"schema":{"$ref":"#/definitions/WidgetConfiguration"},"required":true,"name":"WidgetConfiguration","in":"body"}],"produces":["application/json"],"tags":["System Administration","Monitoring","Dashboards","Widget Configuration"],"summary":"Creates a new Widget Configuration.","x-vmw-nsx-module":"NsxDashboard","consumes":["application/json"],"operationId":"CreateWidgetConfiguration"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/WidgetConfigurationList"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"If no query params are specified then all the Widget Configurations of\nthe specified view are returned.\n","parameters":[{"required":true,"type":"string","name":"view-id","in":"path"},{"description":"Id of the container","maxLength":255,"type":"string","name":"container","in":"query"},{"description":"Ids of the WidgetConfigurations","maxLength":8192,"type":"string","name":"widget_ids","in":"query"}],"produces":["application/json"],"tags":["System Administration","Monitoring","Dashboards","Widget Configuration"],"summary":"Returns the Widget Configurations based on query criteria defined in WidgetQueryParameters.","x-vmw-nsx-module":"NsxDashboard","consumes":["application/json"],"operationId":"ListWidgetConfigurations"}},"/node/file-store/{file-name}?action=copy_to_remote_file":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"504":{"description":"Gateway Timeout"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Copy a file in the file store to a remote server. If you use scp or\nsftp, you must provide the remote server's SSH fingerprint. See the\nNSX-T Administration Guide for information and instructions\nabout finding the SSH fingerprint.\n","parameters":[{"description":"Destination filename","required":true,"type":"string","name":"file-name","in":"path"},{"schema":{"$ref":"#/definitions/CopyToRemoteFileProperties"},"required":true,"name":"CopyToRemoteFileProperties","in":"body"}],"tags":["System Administration","Configuration","Fabric","Nodes","File Store"],"summary":"Copy file in the file store to a remote file store","x-vmw-nsx-module":"FileStoreModule","consumes":["application/json"],"operationId":"CopyToRemoteFileCopyToRemoteFile"}},"/dns/forwarders/{forwarder-id}/statistics":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DnsForwarderStatistics"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the statistics of the given dns forwarder specified by forwarder id.\n","parameters":[{"required":true,"type":"string","name":"forwarder-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Services","DNS"],"summary":"Get statistics of given dns forwarder","x-vmw-nsx-module":"AggSvcDnsForwarder","consumes":["application/json"],"operationId":"GetDnsForwarderStatistics"}},"/serviceinsertion/service-managers/{service-manager-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ServiceManager"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update service-manager which is registered with NSX with basic details like name, username, password.","parameters":[{"required":true,"type":"string","name":"service-manager-id","in":"path"},{"schema":{"$ref":"#/definitions/ServiceManager"},"required":true,"name":"ServiceManager","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Update service manager","x-vmw-nsx-module":"ServiceInsertion","consumes":["application/json"],"operationId":"UpdateServiceManager"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ServiceManager"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Retrieve service-manager details like name, username, password, vendor ID, thumbprint for a given ID.","parameters":[{"required":true,"type":"string","name":"service-manager-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Get service manager","x-vmw-nsx-module":"ServiceInsertion","consumes":["application/json"],"operationId":"GetServiceManager"},"delete":{"responses":{"200":{"description":"OK"},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete service-manager which is registered with NSX with basic details like name, username, password.","parameters":[{"required":true,"type":"string","name":"service-manager-id","in":"path"}],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Delete service manager","x-vmw-nsx-module":"ServiceInsertion","consumes":["application/json"],"operationId":"DeleteServiceManager"}},"/transport-zones/{zone-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TransportZone"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Updates an existing transport zone. Modifiable parameters are\nis_default, description, and display_name. The\nrequest must include the existing host_switch_name. This api is now deprecated. Use new api -\nPATCH /infra/sites/<site-id>/enforcement-points/<enforcementpoint-\nid>/transport-zones/<zone-id>\n","parameters":[{"required":true,"type":"string","name":"zone-id","in":"path"},{"schema":{"$ref":"#/definitions/TransportZone"},"required":true,"name":"TransportZone","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Transport Zones"],"summary":"Update a Transport Zone","x-vmw-nsx-module":"TransportZone","consumes":["application/json"],"operationId":"UpdateTransportZone"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TransportZone"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about a single transport zone. This api is now deprecated. Please use new api - /infra/sites/<site-id>/enforcement-points/<enforcementpoint- id>/transport-zones/<zone-id>","parameters":[{"required":true,"type":"string","name":"zone-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Transport Zones"],"summary":"Get a Transport Zone","x-vmw-nsx-module":"TransportZone","consumes":["application/json"],"operationId":"GetTransportZone"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Deletes an existing transport zone. This api is now deprecated. Please use new api - DELETE /infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/transport-zones/<zone-id>","parameters":[{"required":true,"type":"string","name":"zone-id","in":"path"}],"tags":["System Administration","Configuration","Fabric","Transport Zones"],"summary":"Delete a Transport Zone","x-vmw-nsx-module":"TransportZone","consumes":["application/json"],"operationId":"DeleteTransportZone"}},"/serviceinsertion/excludelist?action=add_member":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResourceReference"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Note- POST serviceinsertion excludelist API is deprecated. Please use the\npolicy serviceinsertion excludelist API instead.\n","parameters":[{"schema":{"$ref":"#/definitions/ResourceReference"},"required":true,"name":"ResourceReference","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Add a new member in the exclude list","x-vmw-nsx-module":"ServiceInsertionExcludeList","consumes":["application/json"],"operationId":"AddServiceInsertionExcludeListMember"}},"/serviceinsertion/sections/{section-id}?action=list_with_rules":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ServiceInsertionSectionRuleList"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns serviceinsertion section information with rules for a section identifier.\nWhen invoked on a section with a large number of rules, this API is supported\nonly at low rates of invocation (not more than 4-5 times per minute). The\ntypical latency of this API with about 1024 rules is about 4-5 seconds. This\nAPI should not be invoked with large payloads at automation speeds. More than\n50 rules are not supported.\n\nInstead, to read serviceinsertion rules, use:\nGET /api/v1/serviceinsertion/sections/<section-id>/rules with the appropriate\npage_size.\nNote- GET service insertion section with rules API is deprecated.\nPlease use policy redirection-policy API.\n","parameters":[{"required":true,"type":"string","name":"section-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Get an Existing Section, Including Rules","x-vmw-nsx-module":"ServiceInsertionRules","consumes":["application/json"],"operationId":"GetServiceInsertionSectionWithRules"}},"/upgrade/bundles/{bundle-id}":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UpgradeBundleInfo"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get uploaded upgrade bundle information\n","parameters":[{"required":true,"type":"string","name":"bundle-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Upgrade","Bundles"],"summary":"Get uploaded upgrade bundle information","x-vmw-nsx-module":"Upgrade","consumes":["application/json"],"operationId":"GetUpgradeBundleInfo"}},"/pools/vni-pools":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/VniPool"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"description":"Bad Request"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Creates a new VNI pool using the specified VNI pool range. The range\nshould be non-overlapping with an existing range. If the range in\npayload is present or overlaps with an existing range, return code 400\nwith bad request and an error message is returned mentioning that the\ngiven range overlaps with an existing range.\n","parameters":[{"schema":{"$ref":"#/definitions/VniPool"},"required":true,"name":"VniPool","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Pool Management","VNI Pools"],"summary":"Create a new VNI Pool.","x-vmw-nsx-module":"Vnim","consumes":["application/json"],"operationId":"CreateVNIPool"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/VniPoolListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about the default and configured virtual\nnetwork identifier (VNI) pools for use when building logical network\nsegments. Each virtual network has a unique ID called a VNI. Instead\nof creating a new VNI each time you need a new logical switch, you\ncan instead allocate a VNI from a VNI pool. VNI pools are sometimes\ncalled segment ID pools. Each VNI pool has a range of usable VNIs. By\ndefault, there is one pool with two ranges [5000, 65535] and [65536,\n75000]. To create multiple smaller pools, specify a smaller range for\neach pool such as 75001-75100 and 75101-75200. The VNI range determines\nthe maximum number of logical switches that can be created in each\nnetwork segment.\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Pool Management","VNI Pools"],"summary":"List VNI Pools","x-vmw-nsx-module":"Vnim","consumes":["application/json"],"operationId":"ListVNIPools"}},"/node/file-store/{file-name}/data":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FileProperties"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Replace file contents","parameters":[{"description":"Name of the file to replace","required":true,"type":"string","name":"file-name","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","File Store"],"summary":"Replace file contents","x-vmw-nsx-module":"FileStoreModule","consumes":["application/octet-stream"],"operationId":"UpdateFile"},"get":{"responses":{"200":{"description":"OK"},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read file contents","parameters":[{"description":"Name of the file to read","required":true,"type":"string","name":"file-name","in":"path"}],"produces":["application/octet-stream"],"tags":["System Administration","Configuration","Fabric","Nodes","File Store"],"summary":"Read file contents","x-vmw-nsx-module":"FileStoreModule","consumes":["application/json"],"operationId":"ReadFile"}},"/cluster/api-certificate?action=clear_cluster_certificate":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ClusterCertificateId"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Clears the certificate used for the MP cluster.\nThis does not affect the certificate itself.\nThis API is deprecated. Instead use the \n/api/v1/cluster/api-certificate?action=set_cluster_certificate API to set\nthe cluster certificate to a different one.\nIt just means that from now on, individual certificates will be used on\neach MP node. This affects all nodes in the cluster.\n","parameters":[{"description":"Certificate ID","required":true,"type":"string","name":"certificate_id","in":"query"}],"produces":["application/json"],"tags":["System Administration","Configuration","NSX Managers","Clusters","Cluster Certificate"],"summary":"Clear the cluster certificate","x-vmw-nsx-module":"ClusterCertificate","consumes":["application/json"],"operationId":"ClearClusterCertificateClearClusterCertificate"}},"/trust-management/oidc-uris/{id}":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/OidcEndPoint"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"When ?refresh=true is added to the request, the meta-data is newly fetched\nfrom the OIDC end-point.\n","parameters":[{"required":true,"type":"string","name":"id","in":"path"},{"description":"Refresh meta-data","default":false,"required":false,"in":"query","type":"boolean","name":"refresh"}],"produces":["application/json"],"tags":["System Administration","Settings","User Management","Principal Identity"],"summary":"Get an OpenID Connect end-point.","x-vmw-nsx-module":"CertificateManager","consumes":["application/json"],"operationId":"GetOidcEndPoint"}},"/upgrade/upgrade-unit-groups":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/UpgradeUnitGroup"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Create a group of upgrade units.\n","parameters":[{"schema":{"$ref":"#/definitions/UpgradeUnitGroup"},"required":true,"name":"UpgradeUnitGroup","in":"body"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Upgrade","Group"],"summary":"Create a group","x-vmw-nsx-module":"Upgrade","consumes":["application/json"],"operationId":"CreateUpgradeUnitGroup"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UpgradeUnitGroupListResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Return information of all upgrade unit groups in the\nupgrade plan. If request parameter summary is set to true, then\nonly count of upgrade units will be returned, upgrade units list\nwill be empty. If request parameter component type is specified,\nthen all upgrade unit groups for that component will be returned.\n","parameters":[{"description":"Component type based on which upgrade unit groups to be filtered","required":false,"type":"string","name":"component_type","in":"query"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"description":"Flag indicating whether to return summary","default":false,"required":false,"in":"query","type":"boolean","name":"summary"},{"description":"Synchronize before returning upgrade unit groups","default":false,"required":false,"in":"query","type":"boolean","name":"sync"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Upgrade","Group"],"summary":"Return information of all upgrade unit groups","x-vmw-nsx-module":"Upgrade","consumes":["application/json"],"operationId":"GetUpgradeUnitGroups"}},"/transport-zones/{zone-id}/transport-node-status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TransportNodeStatusListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read status of transport nodes in a transport zone","parameters":[{"description":"ID of transport zone","required":true,"type":"string","name":"zone-id","in":"path"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"},{"description":"Transport node","enum":["UP","DOWN","DEGRADED","UNKNOWN"],"type":"string","name":"status","in":"query"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Transport Node Status"],"summary":"Read status of transport nodes in a transport zone","x-vmw-nsx-module":"Heatmap","consumes":["application/json"],"operationId":"ListTransportNodeStatusForTransportZone"}},"/node/services/nsx-upgrade-agent?action=restart":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the NSX upgrade agent service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","Upgrade Agent"],"summary":"Restart, start or stop the NSX upgrade agent service","x-vmw-nsx-module":"NodeNsxUpgradeAgent","consumes":["application/json"],"operationId":"CreateNsxUpgradeAgentServiceActionRestart"}},"/vpn/l2vpn/sessions/{session-id}/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/L2VPNSessionStatus"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Aggregated status of L2VPN session. Query parameter source=realtime|cached is supported.","parameters":[{"required":true,"type":"string","name":"session-id","in":"path"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"}],"produces":["application/json"],"tags":["Management Plane API","Networking","VPN","Statistics","L2VPN Session Status"],"summary":"Get L2VPN session status","x-vmw-nsx-module":"L2VPNStatistics","consumes":["application/json"],"operationId":"GetL2VPNSessionStatus"}},"/node/services/async_replicator?action=stop":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the Async Replicator service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Async Replicator Service"],"summary":"Restart, start or stop the Async Replicator service","x-vmw-nsx-module":"NodeAsyncReplicatorService","consumes":["application/json"],"operationId":"CreateAsyncReplicatorServiceActionStop"}},"/loadbalancer/application-profiles/{application-profile-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LbAppProfile"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update a load balancer application profile.\n","parameters":[{"required":true,"type":"string","name":"application-profile-id","in":"path"},{"schema":{"$ref":"#/definitions/LbAppProfile"},"required":true,"name":"LbAppProfile","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Update a load balancer application profile","x-vmw-nsx-module":"LoadBalancer","consumes":["application/json"],"operationId":"UpdateLoadBalancerApplicationProfile"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete a load balancer application profile.\n","parameters":[{"required":true,"type":"string","name":"application-profile-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Delete a load balancer application profile","x-vmw-nsx-module":"LoadBalancer","consumes":["application/json"],"operationId":"DeleteLoadBalancerApplicationProfile"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LbAppProfile"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Retrieve a load balancer application profile.\n","parameters":[{"required":true,"type":"string","name":"application-profile-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Retrieve a load balancer application profile","x-vmw-nsx-module":"LoadBalancer","consumes":["application/json"],"operationId":"ReadLoadBalancerApplicationProfile"}},"/node/services/ntp?action=restart":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the NTP service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","NTP"],"summary":"Restart, start or stop the NTP service","x-vmw-nsx-module":"NodeNTPService","consumes":["application/json"],"operationId":"CreateNTPServiceActionRestart"}},"/node/services/manager?action=restart":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Manager Service"],"summary":"Restart, start or stop the service","x-vmw-nsx-module":"NodeProtonService","consumes":["application/json"],"operationId":"CreateProtonServiceActionRestart"}},"/node/services/snmp":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeSnmpServiceProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"409":{"description":"Conflict"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update SNMP service properties.","parameters":[{"schema":{"$ref":"#/definitions/NodeSnmpServiceProperties"},"required":true,"name":"NodeSnmpServiceProperties","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","SNMP"],"summary":"Update SNMP service properties","x-vmw-nsx-module":"NodeSNMPService","consumes":["application/json"],"operationId":"UpdateSNMPService"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeSnmpServiceProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read SNMP service properties.","parameters":[{"description":"Show SNMP sensitive data or not","default":false,"required":false,"in":"query","type":"boolean","name":"show_sensitive_data"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","SNMP"],"summary":"Read SNMP service properties","x-vmw-nsx-module":"NodeSNMPService","consumes":["application/json"],"operationId":"ReadSNMPService"}},"/pools/mac-pools":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MacPoolListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns a list of all the MAC pools\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Pool Management","MAC Pools"],"summary":"List MAC Pools","x-vmw-nsx-module":"MACAM","consumes":["application/json"],"operationId":"ListMacPools"}},"/node/services/manager":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeProtonServiceProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update service properties","parameters":[{"schema":{"$ref":"#/definitions/NodeProtonServiceProperties"},"required":true,"name":"NodeProtonServiceProperties","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Manager Service"],"summary":"Update service properties","x-vmw-nsx-module":"NodeProtonService","consumes":["application/json"],"operationId":"UpdateProtonService"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeProtonServiceProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read service properties","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Manager Service"],"summary":"Read service properties","x-vmw-nsx-module":"NodeProtonService","consumes":["application/json"],"operationId":"ReadProtonService"}},"/serviceinsertion/services/{service-id}/service-instances/{service-instance-id}/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ServiceInstanceStatus"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns status of one instance of a deployed partner service using service insertion framework.\nBy default this API would return cached status. Caching happens every 3 minutes.\nFor realtime status, query parameter \"source=realtime\" needs to be passed.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"required":true,"type":"string","name":"service-instance-id","in":"path"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Get Service-Instance status for Service.","x-vmw-nsx-module":"ServiceInsertionVMDeployment","consumes":["application/json"],"operationId":"GetServiceInstanceStatus"}},"/mac-sets/{mac-set-id}/members":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/MACAddressElement"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Add an individual MAC address to a MACSet\n","parameters":[{"description":"MAC Set Id","required":true,"type":"string","name":"mac-set-id","in":"path"},{"schema":{"$ref":"#/definitions/MACAddressElement"},"required":true,"name":"MACAddressElement","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Grouping Objects","MAC Sets"],"summary":"Add a MAC address to a MACSet","x-vmw-nsx-module":"MACSet","consumes":["application/json"],"operationId":"AddMACAddress"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MACAddressElementListResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"List all MAC addresses in a MACSet\n","parameters":[{"description":"MAC Set Id","required":true,"type":"string","name":"mac-set-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Grouping Objects","MAC Sets"],"summary":"Get all MACAddresses in a MACSet","x-vmw-nsx-module":"MACSet","consumes":["application/json"],"operationId":"GetMACAddresses"}},"/logical-routers/{logical-router-id}/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LogicalRouterStatus"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns status for the Logical Router of the given id.","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Logical Routers"],"summary":"Get the status for the Logical Router of the given id","x-vmw-nsx-module":"AggSvcLogicalRouter","consumes":["application/json"],"operationId":"GetLogicalRouterStatus"}},"/cluster/restore/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ClusterRestoreStatus"}},"404":{"$ref":"#/responses/NotFound"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ClusterRestoreStatus"}},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"description":"Service Unavailable","schema":{"$ref":"#/definitions/ClusterRestoreStatus"}},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns status information for the specified NSX cluster restore request.\n","parameters":[{"enum":["LOCAL_MANAGER","GLOBAL_MANAGER"],"name":"restore_component","default":"LOCAL_MANAGER","required":false,"in":"query","type":"string"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Backup Restore Management","Restore"],"summary":"Query Restore Request Status","x-vmw-nsx-module":"ClusterNodeBackupRestore","consumes":["application/json"],"operationId":"QueryClusterRestoreStatus"}},"/serviceinsertion/services/{service-id}/service-profiles":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BaseServiceProfile"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Adds a new service profile.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"schema":{"$ref":"#/definitions/BaseServiceProfile"},"required":true,"name":"BaseServiceProfile","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Add ServiceProfile for a given Service.","x-vmw-nsx-module":"ServiceInsertion","consumes":["application/json"],"operationId":"AddSIServiceProfile"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SIServiceProfileListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"List all service profiles of a service.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"List all Service Profiles of a Service.","x-vmw-nsx-module":"ServiceInsertion","consumes":["application/json"],"operationId":"ListSIServiceProfiles"}},"/node/services/messaging-manager/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read NSX Messaging Manager service status","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Messaging Manager Service"],"summary":"Read NSX Messaging Manager service status","x-vmw-nsx-module":"NodeNSXMessagingManagerService","consumes":["application/json"],"operationId":"ReadNSXMessagingManagerServiceStatus"}},"/logical-routers/{logical-router-id}/routing/bgp/neighbors/{id}?action=show-sensitive-data":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BgpNeighbor"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read a specific BGP Neighbor details with password on a Logical Router\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"required":true,"type":"string","name":"id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Routing Configuration"],"summary":"Read a specific BGP Neighbor with password on a Logical Router","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"ReadBgpNeighborWithPassword"}},"/serviceinsertion/services/{service-id}/service-instances/{service-instance-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BaseServiceInstance"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Modifies an existing Service-Instance for a given Service-Insertion Service.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"required":true,"type":"string","name":"service-instance-id","in":"path"},{"schema":{"$ref":"#/definitions/BaseServiceInstance"},"required":true,"name":"BaseServiceInstance","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Update an existing Service-Instance.","x-vmw-nsx-module":"ServiceInsertion","consumes":["application/json"],"operationId":"UpdateServiceInstance"},"delete":{"responses":{"200":{"description":"OK"},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete existing Service-Instance for a given Service-Insertion Service.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"required":true,"type":"string","name":"service-instance-id","in":"path"}],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Delete an existing Service-Instance","x-vmw-nsx-module":"ServiceInsertion","consumes":["application/json"],"operationId":"DeleteServiceInstance"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BaseServiceInstance"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns Service-Instance information for a given Service-Insertion Service.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"required":true,"type":"string","name":"service-instance-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Get Service-Instance for Service.","x-vmw-nsx-module":"ServiceInsertion","consumes":["application/json"],"operationId":"GetServiceInstance"}},"/loadbalancer/server-ssl-profiles":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/LbServerSslProfile"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Create a load balancer server-ssl profile.\n","parameters":[{"schema":{"$ref":"#/definitions/LbServerSslProfile"},"required":true,"name":"LbServerSslProfile","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Create a load balancer server-ssl profile","x-vmw-nsx-module":"LoadBalancer","consumes":["application/json"],"operationId":"CreateLoadBalancerServerSslProfile"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LbServerSslProfileListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Retrieve a paginated list of load balancer server-ssl profiles.\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Retrieve a paginated list of load balancer server-ssl profiles","x-vmw-nsx-module":"LoadBalancer","consumes":["application/json"],"operationId":"ListLoadBalancerServerSslProfiles"}},"/vpn/ipsec/peer-endpoints/{ipsec-vpn-peer-endpoint-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IPSecVPNPeerEndpoint"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Edit custom IPSec peer endpoint. System owned endpoints are non editable.","parameters":[{"required":true,"type":"string","name":"ipsec-vpn-peer-endpoint-id","in":"path"},{"schema":{"$ref":"#/definitions/IPSecVPNPeerEndpoint"},"required":true,"name":"IPSecVPNPeerEndpoint","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","VPN","IPSEC","Peer Endpoints"],"summary":"Edit custom IPSecPeerEndpoint","x-vmw-nsx-module":"IPSecVPN","consumes":["application/json"],"operationId":"UpdateIPSecVPNPeerEndpoint"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IPSecVPNPeerEndpoint"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get custom IPSec VPN peer endpoint.","parameters":[{"required":true,"type":"string","name":"ipsec-vpn-peer-endpoint-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","VPN","IPSEC","Peer Endpoints"],"summary":"Get IPSec VPN peer endpoint","x-vmw-nsx-module":"IPSecVPN","consumes":["application/json"],"operationId":"GetIPSecVPNPeerEndpoint"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete custom IPSec VPN peer endpoint. All references are strong references and dependent peer endpoints can not be deleted if being referenced.","parameters":[{"required":true,"type":"string","name":"ipsec-vpn-peer-endpoint-id","in":"path"},{"default":false,"description":"Force delete the resource even if it is being used somewhere\n","type":"boolean","name":"force","in":"query"}],"tags":["Management Plane API","Networking","VPN","IPSEC","Peer Endpoints"],"summary":"Delete custom IPSec VPN peer endpoint","x-vmw-nsx-module":"IPSecVPN","consumes":["application/json"],"operationId":"DeleteIPSecVPNPeerEndpoint"}},"/node/services/messaging-manager?action=start":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the NSX Messaging Manager service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Messaging Manager Service"],"summary":"Restart, start or stop the NSX Messaging Manager service","x-vmw-nsx-module":"NodeNSXMessagingManagerService","consumes":["application/json"],"operationId":"CreateNSXMessagingManagerServiceActionStart"}},"/ipv6/dad-profiles":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DADProfile"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Adds a new DADProfile\n","parameters":[{"schema":{"$ref":"#/definitions/DADProfile"},"required":true,"name":"DADProfile","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Routing Configuration"],"summary":"Create a new DADProfile","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"CreateDADProfile"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DADProfileListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns all IPv6 DADProfiles.\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Routing Configuration"],"summary":"Read All IPV6 DADProfiles","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"ListDADProfiles"}},"/cluster/{node-id}?action=remove_node":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ClusterConfiguration"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"description":"Service Unavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Detach a node from the Cluster","parameters":[{"description":"UUID of the node","required":true,"type":"string","name":"node-id","in":"path"},{"enum":["true","false"],"type":"string","name":"force","in":"query"},{"enum":["true","false"],"name":"graceful-shutdown","default":"false","required":false,"in":"query","type":"string"},{"enum":["true","false"],"name":"ignore-repository-ip-check","default":"false","required":false,"in":"query","type":"string"}],"produces":["application/json"],"tags":["System Administration","Configuration","NSX Managers","Clusters","Cluster Configuration"],"summary":"Detach a node from the Cluster","x-vmw-nsx-module":"ClusterModule","consumes":["application/json"],"operationId":"DetachClusterNodeRemoveNode"}},"/transport-nodes/{edge-node-id}/inter-site/bgp/neighbors/{neighbor-id}/routes":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BgpNeighborRouteDetails"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns routes learned by BGP neighbor from the given edge transport node.\nIt always returns realtime response.\n","parameters":[{"required":true,"type":"string","name":"edge-node-id","in":"path"},{"required":true,"type":"string","name":"neighbor-id","in":"path"}],"produces":["application/json"],"tags":["Federation","Inter-Sites"],"summary":"Get BGP neighbor learned routes on edge transport node","x-vmw-nsx-module":"AggSvcInterSite","consumes":["application/json"],"operationId":"GetInterSiteEdgeNodeBgpNeighborRoutes"}},"/repository/bundles":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BundleId"}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Upload the bundle from remote bundle URL. The call returns after fetch is initiated.\nCheck status by periodically retrieving bundle upload status\nusing GET /repository/bundles/<bundle-id>/upload-status.\nThe upload is complete when the status is SUCCESS.\n","parameters":[{"schema":{"$ref":"#/definitions/RemoteBundleUrl"},"required":true,"name":"RemoteBundleUrl","in":"body"},{"enum":["OVA"],"description":"Type of file","required":true,"in":"query","type":"string","name":"file_type"},{"enum":["SAMPLE","ALB_CONTROLLER","INTELLIGENCE"],"description":"Name of the appliance","required":true,"in":"query","type":"string","name":"product"}],"produces":["application/json"],"tags":["System Administration","Configuration","NSX Intelligence","Repository","Bundles"],"summary":"Upload bundle using remote file","x-vmw-nsx-module":"FileUploadFramework","consumes":["application/json"],"operationId":"UploadBundleViaRemoteFile"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BundleIds"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get list of bundle-ids which are available in repository or in-progress\n","parameters":[{"enum":["OVA"],"description":"Type of file","required":true,"in":"query","type":"string","name":"file_type"},{"enum":["SAMPLE","ALB_CONTROLLER","INTELLIGENCE"],"description":"Name of the appliance","required":true,"in":"query","type":"string","name":"product"}],"produces":["application/json"],"tags":["System Administration","Configuration","NSX Intelligence","Repository","Bundles"],"summary":"Get list of bundle-ids which are available in repository or in-progress\n","x-vmw-nsx-module":"FileUploadFramework","consumes":["application/json"],"operationId":"GetBundleIds"}},"/systemhealth/plugins":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/SystemHealthPluginProfile"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Create a system health plugin.\n","parameters":[{"schema":{"$ref":"#/definitions/SystemHealthPluginProfile"},"required":true,"name":"SystemHealthPluginProfile","in":"body"}],"produces":["application/json"],"tags":["System Administration","Monitoring","System Health","Plugins"],"summary":"Create a system health plugin","x-vmw-nsx-module":"SystemHealthPlugin","consumes":["application/json"],"operationId":"CreateSystemHealthPlugin"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SystemHealthPluginProfileList"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Show all the system health plugins.\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["System Administration","Monitoring","System Health","Plugins"],"summary":"Show all the system health plugin","x-vmw-nsx-module":"SystemHealthPlugin","consumes":["application/json"],"operationId":"ListAllSystemHealthPlugins"}},"/node/services/cluster_manager/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read cluster boot manager service status","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Cluster Manager Service"],"summary":"Read cluster boot manager service status","x-vmw-nsx-module":"NodeClusterBootManagerService","consumes":["application/json"],"operationId":"ReadClusterBootManagerServiceStatus"}},"/normalizations":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NormalizedResourceListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the list of normalized resources based on the query parameters.\nId and Type of the resource on which the normalizations is to be performed,\nare to be specified as query parameters in the URI. The target resource\ntypes to which normalization is to be done should also be specified as\nquery parameter.\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"enum":["NSGroup","IPSet","MACSet","LogicalSwitch","LogicalPort","DirectoryGroup"],"description":"Resource type valid for use as target in normalization API.","required":true,"in":"query","type":"string","name":"preferred_normalization_type"},{"description":"Identifier of the resource on which normalization is to be performed","required":true,"type":"string","name":"resource_id","in":"query"},{"enum":["NSGroup"],"description":"Resource type valid for use as source in normalization API.","required":true,"in":"query","type":"string","name":"resource_type"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Normalization"],"summary":"Get normalizations based on the query parameters","x-vmw-nsx-module":"Normalization","consumes":["application/json"],"operationId":"GetNormalizations"}},"/fabric/virtual-machines?action=update_tags":{"post":{"responses":{"204":{"description":"No Content"},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Perform action on a specific virtual machine. External id of the virtual machine needs to be\nprovided in the request body. Some of the actions that can be performed are update tags, add\ntags, remove tags.\nTo add tags to existing list of tag, use action parameter add_tags.\nTo remove tags from existing list of tag, use action parameter remove_tags.\nTo replace existing tags with new tags, use action parameter update_tags.\nTo clear all tags, provide an empty list and action parameter as update_tags.\nThe vmw-async: True HTTP header cannot be used with this API.\n","parameters":[{"schema":{"$ref":"#/definitions/VirtualMachineTagUpdate"},"required":true,"name":"VirtualMachineTagUpdate","in":"body"}],"tags":["Policy","Inventory","Virtual Machines"],"summary":"Perform action on specified virtual machine e.g. update tags","x-vmw-nsx-module":"InventoryVmTag","consumes":["application/json"],"operationId":"UpdateVirtualMachineTags"}},"/firewall/status/{context-type}/{id}":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TargetResourceStatus"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get firewall status for target resource in dfw context","parameters":[{"required":true,"type":"string","name":"context-type","in":"path"},{"required":true,"type":"string","name":"id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Firewall"],"summary":"Get firewall status for target resource in dfw context","x-vmw-nsx-module":"FirewallStatus","consumes":["application/json"],"operationId":"GetFirewallStatusOnTargetResource"}},"/ipfix/configs":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/IpfixConfig"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"description":"Bad Request"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Create a new IPFIX configuration","parameters":[{"schema":{"$ref":"#/definitions/IpfixConfig"},"required":true,"name":"IpfixConfig","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Troubleshooting And Monitoring","IPFIX"],"summary":"Create a new IPFIX configuration","x-vmw-nsx-module":"Ipfix","consumes":["application/json"],"operationId":"CreateIpfixConfig"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IpfixConfigListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"List IPFIX configuration","parameters":[{"description":"Applied To","required":false,"type":"string","name":"applied_to","in":"query"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"enum":["IpfixDfwConfig"],"description":"Supported IPFIX Config Types.","required":false,"in":"query","type":"string","name":"ipfix_config_type"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Troubleshooting And Monitoring","IPFIX"],"summary":"List IPFIX configuration","x-vmw-nsx-module":"Ipfix","consumes":["application/json"],"operationId":"ListIpfixConfig"}},"/eula/content":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EULAContent"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Return the content of end user license agreement in the specified format.\nBy default, it's pure string without line break\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"description":"End User License Agreement content output format","type":"string","name":"value_format","in":"query"}],"produces":["application/json"],"tags":["System Administration","Settings","Licenses"],"summary":"Return the content of end user license agreement\n","x-vmw-nsx-module":"EULA","consumes":["application/json"],"operationId":"GetEULAContent"}},"/upgrade/version-whitelist":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AcceptableComponentVersionList"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get whitelist of versions for different components","produces":["application/json"],"tags":["System Administration","Lifecycle Management","Upgrade","Nodes"],"summary":"Get the version whitelist","x-vmw-nsx-module":"VersionWhitelist","consumes":["application/json"],"operationId":"GetVersionWhitelist"}},"/node/services/liagent?action=stop":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the liagent service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","Log Insight"],"summary":"Restart, start or stop the liagent service","x-vmw-nsx-module":"NodeLiagentService","consumes":["application/json"],"operationId":"CreateLiagentServiceActionStop"}},"/migration/mp-to-policy":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"This will trigger the migration from mp to policy\n","parameters":[{"schema":{"$ref":"#/definitions/MpMigrationData"},"required":true,"name":"MpMigrationData","in":"body"}],"tags":["System Administration","Lifecycle Management","Migration","Plan"],"summary":"This will trigger the migration from mp to policy.","x-vmw-nsx-module":"MPPolicyMigration","consumes":["application/json"],"operationId":"MigrateMPDataToPolicy"}},"/node/services/ntp":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeNtpServiceProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update NTP service properties","parameters":[{"schema":{"$ref":"#/definitions/NodeNtpServiceProperties"},"required":true,"name":"NodeNtpServiceProperties","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","NTP"],"summary":"Update NTP service properties","x-vmw-nsx-module":"NodeNTPService","consumes":["application/json"],"operationId":"UpdateNTPService"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeNtpServiceProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read NTP service properties","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","NTP"],"summary":"Read NTP service properties","x-vmw-nsx-module":"NodeNTPService","consumes":["application/json"],"operationId":"ReadNTPService"}},"/notification-watchers/{watcher-id}/notifications":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NotificationsList"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update notifications for the specified watcher ID.","parameters":[{"required":true,"type":"string","name":"watcher-id","in":"path"},{"schema":{"$ref":"#/definitions/NotificationsList"},"required":true,"name":"NotificationsList","in":"body"}],"produces":["application/json"],"tags":["System Administration","Monitoring","Notifications"],"summary":"Update notifications for the specified watcher ID.","x-vmw-nsx-module":"NfwConfig","consumes":["application/json"],"operationId":"UpdateNotifications"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NotificationsList"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get notifications for the specified watcher ID.","parameters":[{"required":true,"type":"string","name":"watcher-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Monitoring","Notifications"],"summary":"Get notifications for the specified watcher ID.","x-vmw-nsx-module":"NfwConfig","consumes":["application/json"],"operationId":"GetNotifications"}},"/loadbalancer/services/{service-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LbService"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update a load balancer service.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"schema":{"$ref":"#/definitions/LbService"},"required":true,"name":"LbService","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Update a load balancer service","x-vmw-nsx-module":"LoadBalancer","consumes":["application/json"],"operationId":"UpdateLoadBalancerService"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete a load balancer service.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Delete a load balancer service","x-vmw-nsx-module":"LoadBalancer","consumes":["application/json"],"operationId":"DeleteLoadBalancerService"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LbService"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Retrieve a load balancer service.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Retrieve a load balancer service","x-vmw-nsx-module":"LoadBalancer","consumes":["application/json"],"operationId":"ReadLoadBalancerService"}},"/cluster/nodes/deployments/{node-id}/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ClusterNodeVMDeploymentStatusReport"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the current deployment or undeployment status for a VM along with\nany other relevant current information, such as error messages.\n","parameters":[{"required":true,"type":"string","name":"node-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","NSX Managers","Clusters","Cluster Node Deployments"],"summary":"Returns the status of the VM creation/deletion","x-vmw-nsx-module":"ClusterNodeVMDeployment","consumes":["application/json"],"operationId":"ReadClusterNodeVMDeploymentStatus"}},"/trust-management/csrs/{csr-id}":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Csr"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about the specified CSR.","parameters":[{"description":"ID of CSR to read","required":true,"type":"string","name":"csr-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Settings","Certificates","CSR"],"summary":"Show CSR Data for the Given CSR ID","x-vmw-nsx-module":"CertificateManager","consumes":["application/json"],"operationId":"GetCsr"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Removes a specified CSR. If a CSR is not used for verification, you can\ndelete it.\n","parameters":[{"description":"ID of CSR to delete","required":true,"type":"string","name":"csr-id","in":"path"}],"tags":["System Administration","Settings","Certificates","CSR"],"summary":"Delete a CSR","x-vmw-nsx-module":"CertificateManager","consumes":["application/json"],"operationId":"DeleteCsr"}},"/nvds-urt?action=ignore_migrate_status":{"post":{"responses":{"200":{"description":"OK"},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Set the migrate status key of ExtraConfigProfile of all Transport Nodes to IGNORE","tags":["System Administration","Configuration","Fabric","Nodes","Transport Nodes"],"summary":"Set the migrate status key of ExtraConfigProfile of all Transport Nodes to IGNORE","x-vmw-nsx-module":"NvdsUpgradeReadinessCheck","consumes":["application/json"],"operationId":"IgnoreMigrateStatus"}},"/ui-views/{view-id}/widgetconfigurations/{widgetconfiguration-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/WidgetConfiguration"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Updates the widget at the given view. If the widget is referenced by other\nviews, then the widget will be updated in all the views that it is part of.\n","parameters":[{"required":true,"type":"string","name":"view-id","in":"path"},{"required":true,"type":"string","name":"widgetconfiguration-id","in":"path"},{"schema":{"$ref":"#/definitions/WidgetConfiguration"},"required":true,"name":"WidgetConfiguration","in":"body"}],"produces":["application/json"],"tags":["System Administration","Monitoring","Dashboards","Widget Configuration"],"summary":"Update Widget Configuration","x-vmw-nsx-module":"NsxDashboard","consumes":["application/json"],"operationId":"UpdateWidgetConfiguration"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/WidgetConfiguration"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns Information about a specific Widget Configuration.\n","parameters":[{"required":true,"type":"string","name":"view-id","in":"path"},{"required":true,"type":"string","name":"widgetconfiguration-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Monitoring","Dashboards","Widget Configuration"],"summary":"Returns Widget Configuration Information","x-vmw-nsx-module":"NsxDashboard","consumes":["application/json"],"operationId":"GetWidgetConfiguration"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Detaches widget from a given view. If the widget is no longer part of any\nview, then it will be purged.\n","parameters":[{"required":true,"type":"string","name":"view-id","in":"path"},{"required":true,"type":"string","name":"widgetconfiguration-id","in":"path"}],"tags":["System Administration","Monitoring","Dashboards","Widget Configuration"],"summary":"Delete Widget Configuration","x-vmw-nsx-module":"NsxDashboard","consumes":["application/json"],"operationId":"DeleteWidgetConfiguration"}},"/logical-routers/{logical-router-id}/nat/rules?action=create_multiple":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/NatRuleList"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"description":"Bad Request"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Create multiple NAT rules in a specific logical router.\nThe API succeeds only when all rules are accepted and created successfully.\nAny one validation voilation will fail the API, no rule will be created.\nThe ruleIds of each rules can be found from the responsed message.\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"schema":{"$ref":"#/definitions/NatRuleList"},"required":true,"name":"NatRuleList","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","NAT"],"summary":"Add multiple NAT rules in a specific logical router","x-vmw-nsx-module":"Nat","consumes":["application/json"],"operationId":"AddNatRules"}},"/serviceinsertion/services/{service-id}/service-deployments/{service-deployment-id}/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ServiceDeploymentStatus"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns current status of the deployment of partner service. Available only for EPP Services.\nBy default this API would return cached status. Caching happens every 3 minutes.\nFor realtime status, query parameter \"source=realtime\" needs to be passed.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"required":true,"type":"string","name":"service-deployment-id","in":"path"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Get a particular service deployment status.","x-vmw-nsx-module":"ServiceInsertionVMDeployment","consumes":["application/json"],"operationId":"GetServiceDeploymentStatus"}},"/node/services/http?action=stop":{"post":{"responses":{"202":{"description":"Accepted"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Stop the http service","tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","HTTP Service"],"summary":"Stop the http service","x-vmw-nsx-module":"NodeProxyService","consumes":["application/json"],"operationId":"CreateProxyServiceActionStopStop"}},"/trust-management/certificate-profiles":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/CertificateProfileListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"List the certificate profiles currently active on the NSX Manager.\nThis list depends on the type of instance deployed and which certificates\nare currently managed through the certificate-profile manager. That list is\nexpected to expand in future releases.\n","produces":["application/json"],"tags":["System Administration","Settings","Certificates","Certificate"],"summary":"Return the list of certificate profiles.","x-vmw-nsx-module":"CertificateManager","consumes":["application/json"],"operationId":"ListCertificateProfiles"}},"/loadbalancer/rules/{rule-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LbRule"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update a load balancer rule.\n","parameters":[{"required":true,"type":"string","name":"rule-id","in":"path"},{"schema":{"$ref":"#/definitions/LbRule"},"required":true,"name":"LbRule","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Update a load balancer rule","x-vmw-nsx-module":"LoadBalancer","consumes":["application/json"],"operationId":"UpdateLoadBalancerRule"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LbRule"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Retrieve a load balancer rule.\n","parameters":[{"required":true,"type":"string","name":"rule-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Retrieve a load balancer rule","x-vmw-nsx-module":"LoadBalancer","consumes":["application/json"],"operationId":"ReadLoadBalancerRule"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete a load balancer rule.\n","parameters":[{"required":true,"type":"string","name":"rule-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Delete a load balancer rule","x-vmw-nsx-module":"LoadBalancer","consumes":["application/json"],"operationId":"DeleteLoadBalancerRule"}},"/dhcp/servers/{server-id}/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DhcpServerStatus"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the service status of the given dhcp server.\n","parameters":[{"required":true,"type":"string","name":"server-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","DHCP"],"summary":"Get DHCP service status with given dhcp server id","x-vmw-nsx-module":"AggSvcDhcp","consumes":["application/json"],"operationId":"GetDhcpStatus"}},"/repository/bundles/{bundle-id}/upload-status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BundleUploadStatus"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get uploaded bundle upload status","parameters":[{"required":true,"type":"string","name":"bundle-id","in":"path"},{"enum":["SAMPLE","ALB_CONTROLLER","INTELLIGENCE"],"description":"Name of the appliance","required":true,"in":"query","type":"string","name":"product"}],"produces":["application/json"],"tags":["System Administration","Configuration","NSX Intelligence","Repository","Bundles"],"summary":"Get bundle upload status","x-vmw-nsx-module":"FileUploadFramework","consumes":["application/json"],"operationId":"GetBundleUploadStatus"}},"/node/services/nsx-upgrade-agent?action=start":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the NSX upgrade agent service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","Upgrade Agent"],"summary":"Restart, start or stop the NSX upgrade agent service","x-vmw-nsx-module":"NodeNsxUpgradeAgent","consumes":["application/json"],"operationId":"CreateNsxUpgradeAgentServiceActionStart"}},"/lldp/fabric-nodes/{fabric-node-id}/interfaces":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/InterfaceNeighborPropertyListResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"List LLDP Neighbor Properties for all interfaces of Fabric Node\n","parameters":[{"description":"ID of fabric node","required":true,"type":"string","name":"fabric-node-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","LLDP"],"summary":"List LLDP Neighbor Properties of Fabric Node","x-vmw-nsx-module":"Lldp","consumes":["application/json"],"operationId":"ListFabricNodeNeighborProperties"}},"/upgrade/upgrade-units-stats":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UpgradeUnitTypeStatsList"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get upgrade units stats","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"description":"Synchronize before returning upgrade unit stats","default":false,"required":false,"in":"query","type":"boolean","name":"sync"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Upgrade","Upgrade Units"],"summary":"Get upgrade units stats","x-vmw-nsx-module":"Upgrade","consumes":["application/json"],"operationId":"GetUpgradeUnitsStats"}},"/upgrade?action=upgrade_uc":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"description":"Internal Server Error"}},"description":"Upgrade the upgrade coordinator module itself. This call is invoked\nafter user uploads an upgrade bundle. Once this call is invoked,\nupgrade coordinator stops and gets restarted and target version\nupgrade coordinator module comes up after restart.\n","tags":["System Administration","Lifecycle Management","Upgrade","Bundles"],"summary":"Upgrade the upgrade coordinator.","x-vmw-nsx-module":"Upgrade","consumes":["application/json"],"operationId":"TriggerUcUpgrade"}},"/node/services/ssh?action=start":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the ssh service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","SSH"],"summary":"Restart, start or stop the ssh service","x-vmw-nsx-module":"NodeSSHService","consumes":["application/json"],"operationId":"CreateSSHServiceActionStart"}},"/ip-sets/{ip-set-id}/members":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IPAddressElementListResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"List all IP addresses in a IPSet\n","parameters":[{"description":"IP Set Id","required":true,"type":"string","name":"ip-set-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Grouping Objects","IP Sets"],"summary":"Get all IPAddresses in a IPSet","x-vmw-nsx-module":"IPSet","consumes":["application/json"],"operationId":"GetIPAddresses"}},"/upgrade/upgrade-units/aggregate-info":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UpgradeUnitAggregateInfoListResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get upgrade units aggregate-info","parameters":[{"description":"Component type based on which upgrade units to be filtered","required":false,"type":"string","name":"component_type","in":"query"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Identifier of group based on which upgrade units to be filtered","required":false,"type":"string","name":"group_id","in":"query"},{"description":"Flag to indicate whether to return only upgrade units with errors","default":false,"required":false,"in":"query","type":"boolean","name":"has_errors"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Metadata about upgrade unit to filter on","required":false,"type":"string","name":"metadata","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"enum":["SELECTED","DESELECTED","ALL"],"description":"Flag to indicate whether to return only selected, only deselected or both type of upgrade units","default":"ALL","required":false,"in":"query","type":"string","name":"selection_status"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"description":"Display name of upgrade unit","required":false,"type":"string","name":"upgrade_unit_display_name","in":"query"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Upgrade","Upgrade Units"],"summary":"Get upgrade units aggregate-info","x-vmw-nsx-module":"Upgrade","consumes":["application/json"],"operationId":"GetUpgradeUnitAggregateInfo"}},"/node/services/applianceproxy?action=start":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the Appliance Proxy Service","produces":["application/json"],"tags":["Management Plane API","NSX Component Administration","Appliance Management"],"summary":"Restart, start or stop the Appliance Proxy Service","x-vmw-nsx-module":"NodeApplProxy","consumes":["application/json"],"operationId":"CreateApplProxyActionStart"}},"/node/services/liagent":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read liagent service properties","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","Log Insight"],"summary":"Read liagent service properties","x-vmw-nsx-module":"NodeLiagentService","consumes":["application/json"],"operationId":"ReadLiagentService"}},"/trust-management":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TrustManagementData"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about the supported algorithms and key sizes.","produces":["application/json"],"tags":["System Administration","Settings","Certificates","CSR"],"summary":"Return the Properties of a Trust Manager","x-vmw-nsx-module":"CertificateManager","consumes":["application/json"],"operationId":"GetTrustObjects"}},"/dhcp/servers":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/LogicalDhcpServer"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Create a logical DHCP server with v4 and/or v6 servers.\n","parameters":[{"schema":{"$ref":"#/definitions/LogicalDhcpServer"},"required":true,"name":"LogicalDhcpServer","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","DHCP"],"summary":"Create a DHCP server","x-vmw-nsx-module":"Dhcp","consumes":["application/json"],"operationId":"CreateDhcpServer"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LogicalDhcpServerListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"List logical DHCP servers with pagination support.","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","DHCP"],"summary":"Get a paginated list of DHCP servers","x-vmw-nsx-module":"Dhcp","consumes":["application/json"],"operationId":"ListDhcpServers"}},"/automatic-health-checks":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AutomaticHealthCheckListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Query automatic health checks with list parameters.\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["System Administration","Monitoring","Health Checks"],"summary":"List automatic health checks","x-vmw-nsx-module":"HealthCheck","consumes":["application/json"],"operationId":"ListAutomaticHealthChecks"}},"/trust-management/crls?action=import":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/CrlList"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Adds a new certificate revocation list (CRL). The CRL is used to verify the\nclient certificate status against the revocation lists published by the CA.\nFor this reason, the administrator needs to add the CRL in certificate\nrepository as well.\nA CRL can be in the PEM X.509 format (crl_type=X509) or JSON OneCRL\n(crl_type=OneCRL).\nIf crl_type is not specified, it is auto-detected based on the presence of\nfields pem_encoded or one_crl.\n","parameters":[{"schema":{"$ref":"#/definitions/CrlObjectData"},"required":true,"name":"CrlObjectData","in":"body"}],"produces":["application/json"],"tags":["System Administration","Settings","Certificates","CSR"],"summary":"Add a New Certificate Revocation List","x-vmw-nsx-module":"CertificateManager","consumes":["application/json"],"operationId":"AddCrl"}},"/dhcp/servers/{server-id}/ip-pools/{pool-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DhcpIpPool"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update a specific ip pool of a given logical DHCP server.","parameters":[{"required":true,"type":"string","name":"server-id","in":"path"},{"required":true,"type":"string","name":"pool-id","in":"path"},{"schema":{"$ref":"#/definitions/DhcpIpPool"},"required":true,"name":"DhcpIpPool","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","DHCP"],"summary":"Update a DHCP server's IP pool","x-vmw-nsx-module":"Dhcp","consumes":["application/json"],"operationId":"UpdateDhcpIpPool"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DhcpIpPool"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Return a specific ip pool of a given logical DHCP server.","parameters":[{"required":true,"type":"string","name":"server-id","in":"path"},{"required":true,"type":"string","name":"pool-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","DHCP"],"summary":"Get a DHCP server's IP pool with the specified pool ID","x-vmw-nsx-module":"Dhcp","consumes":["application/json"],"operationId":"ReadDhcpIpPool"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete a specific ip pool of a given logical DHCP server.","parameters":[{"required":true,"type":"string","name":"server-id","in":"path"},{"required":true,"type":"string","name":"pool-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","DHCP"],"summary":"Delete a DHCP server's IP pool","x-vmw-nsx-module":"Dhcp","consumes":["application/json"],"operationId":"DeleteDhcpIpPool"}},"/firewall/sections/{section-id}?action=revise_with_rules":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FirewallSectionRuleList"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Modifies an existing firewall section along with its relative position\namong other firewall sections with rules. When invoked on a large number\nof rules, this API is supported only at low rates of invocation (not more\nthan 2 times per minute). The typical latency of this API with about 1024\nrules is about 15 seconds in a cluster setup. This API should not be\ninvoked with large payloads at automation speeds.\n\nInstead, to move a section above or below another section, use:\nPOST /api/v1/firewall/sections/<section-id>?action=revise\n\nTo modify rules, use:\nPUT /api/v1/firewall/sections/<section-id>/rules/<rule-id>\n\nSimultaneous update (modify) operations on same section are not allowed to\nprevent overwriting stale contents to firewall section. If a concurrent\nupdate is performed, HTTP response code 409 will be returned to the client\noperating on stale data. That client should retrieve the firewall section\nagain and re-apply its update.\n","parameters":[{"required":true,"type":"string","name":"section-id","in":"path"},{"schema":{"$ref":"#/definitions/FirewallSectionRuleList"},"required":true,"name":"FirewallSectionRuleList","in":"body"},{"in":"query","description":"Identifier of the anchor rule or section. This is a required field in case operation like 'insert_before' and 'insert_after'.","required":false,"maxLength":64,"type":"string","name":"id"},{"enum":["insert_top","insert_bottom","insert_after","insert_before"],"description":"Operation","default":"insert_top","required":false,"in":"query","type":"string","name":"operation"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Firewall"],"summary":"Update an Existing Section with Rules","x-vmw-nsx-module":"Firewall","consumes":["application/json"],"operationId":"ReviseSectionWithRules"}},"/transport-nodes/{transportnode-id}":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Put transport node into maintenance mode or exit from maintenance mode.","parameters":[{"required":true,"type":"string","name":"transportnode-id","in":"path"},{"enum":["enter_maintenance_mode","forced_enter_maintenance_mode","exit_maintenance_mode"],"type":"string","name":"action","in":"query"}],"tags":["System Administration","Configuration","Fabric","Nodes","Transport Nodes"],"summary":"Update transport node maintenance mode","x-vmw-nsx-module":"TransportNode","consumes":["application/json"],"operationId":"UpdateTransportNodeMaintenanceMode"}},"/fabric/container-application-instances/{container-application-instance-id}":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ContainerApplicationInstance"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about a specific container application instance.","parameters":[{"required":true,"type":"string","name":"container-application-instance-id","in":"path"}],"produces":["application/json"],"tags":["Policy","Inventory","Containers","Container Applications"],"summary":"Return a container application instance","x-vmw-nsx-module":"InventoryContainerObj","consumes":["application/json"],"operationId":"GetContainerApplicationInstance"}},"/fabric/compute-managers/{compute-manager-id}/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ComputeManagerStatus"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns connection and version information about a compute manager\n","parameters":[{"required":true,"type":"string","name":"compute-manager-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Compute Managers"],"summary":"Return runtime status information for a compute manager","x-vmw-nsx-module":"InventoryCmObj","consumes":["application/json"],"operationId":"ReadComputeManagerStatus"}},"/logical-routers/{logical-router-id}/routing/redistribution":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RedistributionConfig"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Modifies existing route redistribution rules for the specified TIER0 logical\nrouter.\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"schema":{"$ref":"#/definitions/RedistributionConfig"},"required":true,"name":"RedistributionConfig","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Routing Configuration"],"summary":"Update the Redistribution Configuration on a Logical Router","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"UpdateRedistributionConfig"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RedistributionConfig"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about configured route redistribution for the specified\nlogical router.\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Routing Configuration"],"summary":"Read the Redistribution Configuration on a Logical Router","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"ReadRedistributionConfig"}},"/upgrade/eula/accept":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Accept end user license agreement\n","produces":["application/json"],"tags":["System Administration","Lifecycle Management","Upgrade","Eula"],"summary":"Accept end user license agreement\n","x-vmw-nsx-module":"UpgradeEULA","consumes":["application/json"],"operationId":"AcceptUpgradeEULA"}},"/logical-routers/{logical-router-id}/routing/bgp/community-lists/{community-list-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BGPCommunityList"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update a specific BGP community list from a Logical Router\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"required":true,"type":"string","name":"community-list-id","in":"path"},{"schema":{"$ref":"#/definitions/BGPCommunityList"},"required":true,"name":"BGPCommunityList","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Routing Configuration"],"summary":"Update a specific BGP community list from a logical router","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"UpdateBGPCommunityList"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BGPCommunityList"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read a specific BGP community list from a Logical Router\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"required":true,"type":"string","name":"community-list-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Routing Configuration"],"summary":"Read a specific BGP community list from a logical router","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"ReadBGPCommunityList"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete a specific BGP community list from a Logical Router\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"required":true,"type":"string","name":"community-list-id","in":"path"}],"tags":["Management Plane API","Networking","Logical Routing And Services","Routing Configuration"],"summary":"Delete a specific BGP community list from a logical router","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"DeleteBGPCommunityList"}},"/transport-node-collections/{transport-node-collection-id}/state":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TransportNodeCollectionState"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the state of transport node collection based on the states of\ntransport nodes of the hosts which are part of compute collection.\n","parameters":[{"required":true,"type":"string","name":"transport-node-collection-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Transport Node Collections"],"summary":"Get Transport Node collection application state","x-vmw-nsx-module":"TransportNodeCollection","consumes":["application/json"],"operationId":"GetTransportNodeCollectionState"}},"/serviceinsertion/services/{service-id}/service-instances/{service-instance-id}/instance-endpoints":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/InstanceEndpoint"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Adds a new instance endpoint. It belongs to one service instance and is attached\nto one service attachment. It represents a redirection target for a Rule.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"required":true,"type":"string","name":"service-instance-id","in":"path"},{"schema":{"$ref":"#/definitions/InstanceEndpoint"},"required":true,"name":"InstanceEndpoint","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Add an InstanceEndpoint for a Service Instance","x-vmw-nsx-module":"ServiceInsertion","consumes":["application/json"],"operationId":"AddInstanceEndpoint"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/InstanceEndpointListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"List all InstanceEndpoints of a service instance.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"required":true,"type":"string","name":"service-instance-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"List all InstanceEndpoints of a Service Instance.","x-vmw-nsx-module":"ServiceInsertion","consumes":["application/json"],"operationId":"ListInstanceEndpoints"}},"/firewall/sections/summary":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FirewallSectionsSummaryList"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"List the summary of number of sections and number of rules for each firewall\ncategory (L2DFW, L3DFW).\n","parameters":[{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Firewall"],"summary":"Get the summary of sections in the firewall configuration.","x-vmw-nsx-module":"FirewallSummary","consumes":["application/json"],"operationId":"GetSectionsSummary"}},"/dhcp/servers/{server-id}/static-bindings":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/DhcpStaticBinding"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Create a static binding for a logical DHCP server.","parameters":[{"required":true,"type":"string","name":"server-id","in":"path"},{"schema":{"$ref":"#/definitions/DhcpStaticBinding"},"required":true,"name":"DhcpStaticBinding","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","DHCP"],"summary":"Create a static binding for a DHCP server","x-vmw-nsx-module":"Dhcp","consumes":["application/json"],"operationId":"CreateDhcpStaticBinding"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DhcpStaticBindingListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Return a paginated list of a static bindings of a given logical DHCP server.\n","parameters":[{"required":true,"type":"string","name":"server-id","in":"path"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","DHCP"],"summary":"Get a paginated list of a DHCP server's static bindings","x-vmw-nsx-module":"Dhcp","consumes":["application/json"],"operationId":"ListDhcpStaticBindings"}},"/cluster/restore/backuptimestamps":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ClusterBackupInfoListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns timestamps for all backup files that are available\non the SFTP server.\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Backup Restore Management","Restore"],"summary":"List timestamps of all available Cluster Backups.","x-vmw-nsx-module":"ClusterRestore","consumes":["application/json"],"operationId":"ListClusterBackupTimestamps"}},"/transport-nodes/{transport-node-id}?action=refresh_node_configuration&resource_type=EdgeNode":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"The API is applicable for Edge transport nodes. If you update the edge\nconfiguration and find a discrepancy in Edge configuration at NSX Manager\nin compare with realized, then use this API to refresh configuration at NSX Manager.\nIt refreshes the Edge configuration from sources external to NSX Manager like\nvSphere Server or the Edge node CLI. After this action, Edge configuration at NSX Manager\nis updated and the API GET api/v1/transport-nodes will show refreshed data.\nFrom 3.2 release onwards, refresh API updates the MP intent by default.\n","parameters":[{"required":true,"type":"string","name":"transport-node-id","in":"path"},{"description":"Read-only flag for Refresh API","default":false,"required":false,"in":"query","type":"boolean","name":"read_only"}],"tags":["System Administration","Configuration","Fabric","Nodes","Transport Nodes"],"summary":"Refresh the node configuration for the Edge node.","x-vmw-nsx-module":"TransportNodeLcm","consumes":["application/json"],"operationId":"RefreshTransportNode"}},"/trust-management/certificate-profile/{service-type}":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/CertificateProfile"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get an available certificate profile.\nNote that not every service type has an active certificate profile.\n","parameters":[{"description":"Unique Service Type of the Certificate Profile","required":true,"type":"string","name":"service-type","in":"path"}],"produces":["application/json"],"tags":["System Administration","Settings","Certificates","Certificate"],"summary":"Get the certificate profile for the given service type","x-vmw-nsx-module":"CertificateManager","consumes":["application/json"],"operationId":"GetCertificateProfile"}},"/directory/domain-size":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DirectoryDomainSize"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"This call scans the size of a directory domain. It may be very | expensive to run this call in some AD domain deployments. Please | use it with caution.","parameters":[{"schema":{"$ref":"#/definitions/DirectoryDomain"},"required":true,"name":"DirectoryDomain","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Directory Service","Domains"],"summary":"Scan the size of a directory domain","x-vmw-nsx-module":"DirectoryService","consumes":["application/json"],"operationId":"ScanDirectoryDomainSize"}},"/fabric/discovered-nodes/{node-ext-id}?action=reapply_cluster_config":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TransportNode"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"When transport node profile (TNP) is applied to a cluster, if any validation fails (e.g. VMs running on host) then transport node (TN) is not created. In that case after the required action is taken (e.g. VMs powered off), you can call this API to try to create TN for that discovered node.\nDo not call this API if Transport Node already exists for the discovered node. In that case use API on transport node. /transport-nodes/<transport-node-id>?action=restore_cluster_config","parameters":[{"required":true,"type":"string","name":"node-ext-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Discovered Nodes"],"summary":"Apply cluster level config on Discovered Node","x-vmw-nsx-module":"TransportNodeLcm","consumes":["application/json"],"operationId":"ReapplyTNProfileOnDiscoveredNode"}},"/cluster/backups/ui_frames":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BackupUiFramesInfoList"}},"404":{"$ref":"#/responses/NotFound"},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/BackupUiFramesInfoList"}},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"description":"Service Unavailable","schema":{"$ref":"#/definitions/BackupUiFramesInfoList"}},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns list of backup frames and some metadata to be used by UI.\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"enum":["LOCAL_MANAGER_TAB","GLOBAL_MANAGER_TAB"],"name":"ui_tab_type","default":"LOCAL_MANAGER_TAB","required":false,"in":"query","type":"string"}],"produces":["application/json"],"tags":["System Administration","Configuration","NSX Managers","Clusters","Cluster Configuration"],"summary":"Get backup frames for UI","x-vmw-nsx-module":"ClusterNodeBackupRestore","consumes":["application/json"],"operationId":"GetBackupUiFramesInfo"}},"/administration/support-bundles?action=collect":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SupportBundleResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"409":{"description":"Conflict"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"502":{"description":"Bad Gateway"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Collect support bundles from registered cluster and fabric nodes.","parameters":[{"schema":{"$ref":"#/definitions/SupportBundleRequest"},"required":true,"name":"SupportBundleRequest","in":"body"},{"default":false,"description":"Override any existing support bundle async response","type":"boolean","name":"override_async_response","in":"query"},{"default":false,"description":"Suppress auto-deletion of generated support bundle","type":"boolean","name":"require_delete_or_override_async_response","in":"query"}],"produces":["application/json","application/octet-stream"],"tags":["System Administration","Settings","Support Bundle"],"summary":"Collect support bundles from registered cluster and fabric nodes","x-vmw-nsx-module":"NodeSupportBundle","consumes":["application/json"],"operationId":"CollectSupportBundlesCollect"}},"/migration/migrated-switches":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MigrationSwitchListResult"}},"401":{"description":"Unauthorized"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get the list of migrated switches (DVS, VSS) for the selected VC.\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Migration","User Inputs"],"summary":"Get the list of migrated switches (DVS, VSS)","x-vmw-nsx-module":"Migration","consumes":["application/json"],"operationId":"GetMigratedSwitches"}},"/switching-profiles/{switching-profile-id}/summary":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SwitchingProfileStatus"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"This api is now deprecated. Please use new api - GET policy/api/v1/infra/realized-state/status?intent_path={{intent-path}}","parameters":[{"required":true,"type":"string","name":"switching-profile-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Switching","Logical Switch Ports"],"summary":"Get Counts of Ports and Switches Using This Switching Profile","x-vmw-nsx-module":"BaseSwitchingProfile","consumes":["application/json"],"operationId":"GetSwitchingProfileStatus"}},"/vpn/ipsec/tunnel-profiles/{ipsec-vpn-tunnel-profile-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IPSecVPNTunnelProfile"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Edit custom IPSec Tunnel Profile. System owned profiles are non editable.","parameters":[{"required":true,"type":"string","name":"ipsec-vpn-tunnel-profile-id","in":"path"},{"schema":{"$ref":"#/definitions/IPSecVPNTunnelProfile"},"required":true,"name":"IPSecVPNTunnelProfile","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","VPN","IPSEC","Tunnel Profiles"],"summary":"Edit custom IPSecTunnelProfile","x-vmw-nsx-module":"IPSecVPN","consumes":["application/json"],"operationId":"UpdateIPSecVPNTunnelProfile"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IPSecVPNTunnelProfile"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get custom IPSec Tunnel Profile.","parameters":[{"required":true,"type":"string","name":"ipsec-vpn-tunnel-profile-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","VPN","IPSEC","Tunnel Profiles"],"summary":"Get IPSec tunnel profile","x-vmw-nsx-module":"IPSecVPN","consumes":["application/json"],"operationId":"GetIPSecVPNTunnelProfile"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete custom IPSec Tunnel Profile.","parameters":[{"required":true,"type":"string","name":"ipsec-vpn-tunnel-profile-id","in":"path"},{"default":false,"description":"Force delete the resource even if it is being used somewhere\n","type":"boolean","name":"force","in":"query"}],"tags":["Management Plane API","Networking","VPN","IPSEC","Tunnel Profiles"],"summary":"Delete custom IPSecTunnelProfile","x-vmw-nsx-module":"IPSecVPN","consumes":["application/json"],"operationId":"DeleteIPSecVPNTunnelProfile"}},"/transport-node-collections/{transport-node-collection-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TransportNodeCollection"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Attach different transport node profile to compute collection by updating\ntransport node collection.\n","parameters":[{"required":true,"type":"string","name":"transport-node-collection-id","in":"path"},{"schema":{"$ref":"#/definitions/TransportNodeCollection"},"required":true,"name":"TransportNodeCollection","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Transport Node Collections"],"summary":"Update Transport Node collection","x-vmw-nsx-module":"TransportNodeCollection","consumes":["application/json"],"operationId":"UpdateTransportNodeCollection"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TransportNodeCollection"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns transport node collection by id","parameters":[{"required":true,"type":"string","name":"transport-node-collection-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Transport Node Collections"],"summary":"Get Transport Node collection by id","x-vmw-nsx-module":"TransportNodeCollection","consumes":["application/json"],"operationId":"GetTransportNodeCollection"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"By deleting transport node collection, we are detaching the transport node\nprofile(TNP) from the compute collection. It has no effect on existing\ntransport nodes. However, new hosts added to the compute collection will no\nlonger be automatically converted to NSX transport node.\nDetaching TNP from compute collection does not delete TNP.\n","parameters":[{"required":true,"type":"string","name":"transport-node-collection-id","in":"path"}],"tags":["System Administration","Configuration","Fabric","Nodes","Transport Node Collections"],"summary":"Detach transport node profile from compute collection.","x-vmw-nsx-module":"TransportNodeCollection","consumes":["application/json"],"operationId":"DeleteTransportNodeCollection"}},"/vpn/l2vpn/sessions/{session-id}/remote-mac":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/L2VPNSessionRemoteMacs"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get L2VPN session remote mac for logical switch.","parameters":[{"required":true,"type":"string","name":"session-id","in":"path"},{"description":"logical switch identifier","type":"string","name":"logical_switch_id","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","VPN","Statistics","L2VPN Remote MACS"],"summary":"Get L2VPN session remote mac for logical switch","x-vmw-nsx-module":"L2VPNStatistics","consumes":["application/json"],"operationId":"GetL2VPNSessionRemoteMacsForLS"}},"/telemetry/config":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TelemetryConfig"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Updates or creates the telemetry configuration, and returns the new configuration.\n","parameters":[{"schema":{"$ref":"#/definitions/TelemetryConfig"},"required":true,"name":"TelemetryConfig","in":"body"}],"produces":["application/json"],"tags":["System Administration","Settings","Customer Experience Improvement","Telemetry"],"summary":"Creates or updates the telemetry configuration","x-vmw-nsx-module":"TelemetryConfig","consumes":["application/json"],"operationId":"UpdateTelemetryConfig"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TelemetryConfig"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the telemetry configuration.","produces":["application/json"],"tags":["System Administration","Settings","Customer Experience Improvement","Telemetry"],"summary":"Returns the telemetry configuration","x-vmw-nsx-module":"TelemetryConfig","consumes":["application/json"],"operationId":"GetTelemetryConfig"}},"/fabric/container-clusters":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ContainerClusterListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about all Container Clusters.","parameters":[{"enum":["PAS","PKS","Kubernetes","Openshift","WCP","WCP_Guest","AKS","EKS","TKGm","TKGi","GKE","Gardener","Rancher","TAS","Other"],"description":"Type of container cluster","required":false,"in":"query","type":"string","name":"cluster_type"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"enum":["vSphere","AWS","Azure","Google","VMC","KVM","Baremetal"],"description":"Type of infrastructure","required":false,"in":"query","type":"string","name":"infra_type"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"description":"Scope id for container cluster","required":false,"type":"string","name":"scope_id","in":"query"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Policy","Inventory","Containers","Container Clusters"],"summary":"Return the List of Container Clusters","x-vmw-nsx-module":"InventoryContainerObj","consumes":["application/json"],"operationId":"ListContainerClusters"}},"/firewall/status/{context-type}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FirewallStatus"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"description":"Bad Request"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update global firewall status for dfw context","parameters":[{"required":true,"type":"string","name":"context-type","in":"path"},{"schema":{"$ref":"#/definitions/FirewallStatus"},"required":true,"name":"FirewallStatus","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Firewall"],"summary":"Update global firewall status for dfw context","x-vmw-nsx-module":"FirewallStatus","consumes":["application/json"],"operationId":"UpdateFirewallStatus"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FirewallStatus"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get firewall global status for dfw context","parameters":[{"required":true,"type":"string","name":"context-type","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Firewall"],"summary":"Get firewall global status for dfw context","x-vmw-nsx-module":"FirewallStatus","consumes":["application/json"],"operationId":"GetFirewallStatus"}},"/vpn/services/{service-id}/summary":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IPSecVPNIKEServiceSummary"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Cumulative statistics for one IKE service instance. Query parameter source supports only cached mode.","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"}],"produces":["application/json"],"tags":["Management Plane API","Networking","VPN","Statistics","IKE Service"],"summary":"Cumulative statistics for one IKE service instance","x-vmw-nsx-module":"VPNStatistics","consumes":["application/json"],"operationId":"GetIPSecVPNIKEService"}},"/firewall/status/{context-type}/{id}?action=enable_firewall":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TargetResourceStatus"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"description":"Bad Request"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Enable firewall on target resource in dfw context","parameters":[{"required":true,"type":"string","name":"context-type","in":"path"},{"required":true,"type":"string","name":"id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Firewall"],"summary":"Enable firewall on target resource in dfw context","x-vmw-nsx-module":"FirewallStatus","consumes":["application/json"],"operationId":"EnableFirewallOnTargetResource"}},"/loadbalancer/pools/{pool-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LbPool"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update a load balancer pool.\n","parameters":[{"required":true,"type":"string","name":"pool-id","in":"path"},{"schema":{"$ref":"#/definitions/LbPool"},"required":true,"name":"LbPool","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Update a load balancer pool","x-vmw-nsx-module":"LoadBalancer","consumes":["application/json"],"operationId":"UpdateLoadBalancerPool"},"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LbPool"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"For ADD_MEMBERS, pool members will be created and added to load balancer\npool. This action is only valid for static pool members.\nFor REMOVE_MEMBERS, pool members will be removed from load balancer pool\nvia IP and port in pool member settings. This action is only valid for\nstatic pool members.\nFor UPDATE_MEMBERS, pool members admin state will be updated. This action\nis valid for both static pool members and dynamic pool members. For dynamic\npool members, this update will be stored in customized_members field in load\nbalancer pool member group.\n","parameters":[{"required":true,"type":"string","name":"pool-id","in":"path"},{"schema":{"$ref":"#/definitions/PoolMemberSettingList"},"required":true,"name":"PoolMemberSettingList","in":"body"},{"enum":["ADD_MEMBERS","REMOVE_MEMBERS","UPDATE_MEMBERS"],"description":"Specifies addition, removal and modification action","required":true,"in":"query","type":"string","name":"action"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Add, remove, or modify load balancer pool members","x-vmw-nsx-module":"LoadBalancer","consumes":["application/json"],"operationId":"PerformPoolMemberAction"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete a load balancer pool.\n","parameters":[{"required":true,"type":"string","name":"pool-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Delete a load balancer pool","x-vmw-nsx-module":"LoadBalancer","consumes":["application/json"],"operationId":"DeleteLoadBalancerPool"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LbPool"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Retrieve a load balancer pool.\n","parameters":[{"required":true,"type":"string","name":"pool-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Retrieve a load balancer pool","x-vmw-nsx-module":"LoadBalancer","consumes":["application/json"],"operationId":"ReadLoadBalancerPool"}},"/intelligence/nodes/deployments":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/IntelligenceClusterNodeVMDeploymentRequestList"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Deploys a Intelligence cluster node VM as specified by the deployment config.\n","parameters":[{"schema":{"$ref":"#/definitions/AddIntelligenceClusterNodeVMInfo"},"required":true,"name":"AddIntelligenceClusterNodeVMInfo","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","NSX Intelligence","Deployments"],"summary":"Deploy and register a Intelligence cluster node VM","x-vmw-nsx-module":"NsxIntelligenceDeployment","consumes":["application/json"],"operationId":"AddPaceClusterNodeVM"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IntelligenceClusterNodeVMDeploymentRequestList"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns request information for every attempted deployment of a cluster\nnode VM.\n","produces":["application/json"],"tags":["System Administration","Configuration","NSX Intelligence","Deployments"],"summary":"Returns info for all cluster node VM auto-deployment attempts","x-vmw-nsx-module":"NsxIntelligenceDeployment","consumes":["application/json"],"operationId":"ListPaceClusterNodeVMDeploymentRequests"}},"/transport-node-profiles/{transport-node-profile-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TransportNodeProfile"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"When configurations of a transport node profile(TNP) is updated, all the\ntransport nodes in all the compute collections to which this TNP is attached\nare updated to reflect the updated configuration.\nThis api is now deprecated. Please use new api -\n/policy/api/v1/infra/host-transport-node-profiles/<host-transport-node-profile-id>\n","parameters":[{"required":true,"type":"string","name":"transport-node-profile-id","in":"path"},{"schema":{"$ref":"#/definitions/TransportNodeProfile"},"required":true,"name":"TransportNodeProfile","in":"body"},{"description":"The network ids to which the ESX vmk interfaces will be migrated","required":false,"type":"string","name":"esx_mgmt_if_migration_dest","in":"query"},{"description":"The ESX vmk interfaces to migrate","required":false,"type":"string","name":"if_id","in":"query"},{"description":"IP Addresses to ping right after ESX vmk interfaces were migrated.","required":false,"type":"string","name":"ping_ip","in":"query"},{"description":"Whether to skip front-end validation for vmk/vnic/pnic migration","default":false,"required":false,"in":"query","type":"boolean","name":"skip_validation"},{"description":"The ESX vmk interfaces and/or VM NIC to migrate","required":false,"type":"string","name":"vnic","in":"query"},{"description":"The migration destinations of ESX vmk interfaces and/or VM NIC","required":false,"type":"string","name":"vnic_migration_dest","in":"query"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Profiles","Transport Node Profiles"],"summary":"Update a Transport Node Profile","x-vmw-nsx-module":"TransportNodeProfile","consumes":["application/json"],"operationId":"UpdateTransportNodeProfile"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Deletes the specified transport node profile. A transport node profile\ncan be deleted only when it is not attached to any compute collection.\nThis api is now deprecated. Please use new api -\n/policy/api/v1/infra/host-transport-node-profiles/<host-transport-node-profile-id>\n","parameters":[{"required":true,"type":"string","name":"transport-node-profile-id","in":"path"}],"tags":["System Administration","Configuration","Fabric","Profiles","Transport Node Profiles"],"summary":"Delete a Transport Node Profile","x-vmw-nsx-module":"TransportNodeProfile","consumes":["application/json"],"operationId":"DeleteTransportNodeProfile"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TransportNodeProfile"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about a specified transport node profile. This api is now deprecated. Please use new api - /policy/api/v1/infra/host-transport-node-profiles/<host-transport-node-profile-id>","parameters":[{"required":true,"type":"string","name":"transport-node-profile-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Profiles","Transport Node Profiles"],"summary":"Get a Transport Node","x-vmw-nsx-module":"TransportNodeProfile","consumes":["application/json"],"operationId":"GetTransportNodeProfile"}},"/node/services/node-stats":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read NSX node-stats service properties","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Node Stats Service"],"summary":"Read NSX node-stats service properties","x-vmw-nsx-module":"NodeNodeStatsService","consumes":["application/json"],"operationId":"ReadNodeStatsService"}},"/bridge-endpoints":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/BridgeEndpoint"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Creates a Bridge Endpoint. It describes the physical attributes of the\nbridge like vlan. A logical port can be attached to a vif providing\nbridging functionality from the logical overlay network to the physical\nvlan network\n","parameters":[{"schema":{"$ref":"#/definitions/BridgeEndpoint"},"required":true,"name":"BridgeEndpoint","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Bridging","Bridge Endpoints"],"summary":"Create a Bridge Endpoint","x-vmw-nsx-module":"BridgeEndpoint","consumes":["application/json"],"operationId":"CreateBridgeEndpoint"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BridgeEndpointListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about all configured bridge endoints\n","parameters":[{"description":"Bridge Cluster Identifier","required":false,"type":"string","name":"bridge_cluster_id","in":"query"},{"description":"Bridge endpoint profile used by the edge cluster","required":false,"type":"string","name":"bridge_endpoint_profile_id","in":"query"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Logical Switch Identifier","required":false,"type":"string","name":"logical_switch_id","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"description":"VLAN transport zone id used by the edge cluster","required":false,"type":"string","name":"vlan_transport_zone_id","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Bridging","Bridge Endpoints"],"summary":"List All Bridge Endpoints","x-vmw-nsx-module":"BridgeEndpoint","consumes":["application/json"],"operationId":"ListBridgeEndpoints"}},"/node/services/migration-coordinator":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read migration coordinator service properties","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Migration Coordinator Service"],"summary":"Read migration coordinator service properties","x-vmw-nsx-module":"NodeMigrationCoordinatorService","consumes":["application/json"],"operationId":"ReadMigrationCoordinatorService"}},"/transport-zones/{zone-id}/summary":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TransportZoneStatus"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about a specified transport zone, including the number\nof logical switches in the transport zone, number of logical spitch ports\nassigned to the transport zone, and number of transport nodes in the\ntransport zone. This api is now deprecated. Please use new api -\nGET policy/api/v1/infra/realized-state/realized-entities?intent_path={{intent-path}}\n","parameters":[{"required":true,"type":"string","name":"zone-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Transport Zones"],"summary":"Get a Transport Zone's Current Runtime Status Information","x-vmw-nsx-module":"TransportZone","consumes":["application/json"],"operationId":"GetTransportZoneStatus"}},"/vpn/ipsec/local-endpoints":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/IPSecVPNLocalEndpoint"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Create custom IPSec local endpoint.","parameters":[{"schema":{"$ref":"#/definitions/IPSecVPNLocalEndpoint"},"required":true,"name":"IPSecVPNLocalEndpoint","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","VPN","IPSEC","Peer Endpoints"],"summary":"Create custom local endpoint","x-vmw-nsx-module":"IPSecVPN","consumes":["application/json"],"operationId":"CreateIPSecVPNLocalEndpoint"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IPSecVPNLocalEndpointListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get paginated list of all local endpoints.","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Id of the IPSec VPN service","required":false,"type":"string","name":"ipsec_vpn_service_id","in":"query"},{"description":"Id of logical router","required":false,"type":"string","name":"logical_router_id","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","VPN","IPSEC","Peer Endpoints"],"summary":"Get IPSec local endpoint list result","x-vmw-nsx-module":"IPSecVPN","consumes":["application/json"],"operationId":"ListIPSecVPNLocalEndpoints"}},"/notification-watchers/{watcher-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NotificationWatcher"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update notification watcher.","parameters":[{"required":true,"type":"string","name":"watcher-id","in":"path"},{"schema":{"$ref":"#/definitions/NotificationWatcher"},"required":true,"name":"NotificationWatcher","in":"body"}],"produces":["application/json"],"tags":["System Administration","Monitoring","Notifications"],"summary":"Update notification watcher.","x-vmw-nsx-module":"NfwConfig","consumes":["application/json"],"operationId":"UpdateNotificationWatcher"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NotificationWatcher"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns notification watcher by watcher id.","parameters":[{"required":true,"type":"string","name":"watcher-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Monitoring","Notifications"],"summary":"Returns notification watcher by watcher id.","x-vmw-nsx-module":"NfwConfig","consumes":["application/json"],"operationId":"GetNotificationWatcher"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete notification watcher.\n","parameters":[{"required":true,"type":"string","name":"watcher-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Monitoring","Notifications"],"summary":"Delete an existing Notification-Watcher.","x-vmw-nsx-module":"NfwConfig","consumes":["application/json"],"operationId":"DeleteNotificationWatcher"}},"/fabric/container-ingress-policies/{ingress-policy-id}":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ContainerIngressPolicy"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about a specific ingress policy.","parameters":[{"required":true,"type":"string","name":"ingress-policy-id","in":"path"}],"produces":["application/json"],"tags":["Policy","Inventory","Containers","Container Clusters"],"summary":"Returns an ingress policy spec","x-vmw-nsx-module":"InventoryContainerObj","consumes":["application/json"],"operationId":"GetContainerIngressPolicy"}},"/transport-nodes/{transport-node-id}?action=restart_inventory_sync":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart the inventory sync for the node if it is currently internally paused.\nAfter this action the next inventory sync coming from the node is processed.\n","parameters":[{"required":true,"type":"string","name":"transport-node-id","in":"path"}],"tags":["System Administration","Configuration","Fabric","Nodes","Transport Nodes"],"summary":"Restart the inventory sync for the node if it is paused currently.","x-vmw-nsx-module":"TransportNodeLcm","consumes":["application/json"],"operationId":"RestartTransportNodeInventorySync"}},"/edge-clusters/{edge-cluster-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EdgeCluster"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Modifies the specified edge cluster. Modifiable parameters include the\ndescription, display_name, transport-node-id. If the optional\nfabric_profile_binding is included, resource_type and profile_id are required.\nUser should do a GET on the edge-cluster and obtain the payload and retain the\nmember_index of the existing members as returning in the GET output. For new member\nadditions, the member_index cannot be defined by the user, user can read the system\nallocated index to the new member in the output of this API call or by doing a GET call.\nUser cannot use this PUT api to replace the transport_node of an existing member because\nthis is a disruption action, we have exposed a explicit API for doing so, refer to\n\"ReplaceEdgeClusterMemberTransportNode\"\nEdgeCluster only supports homogeneous members. The TransportNodes backed by EdgeNode are\nonly allowed in cluster members. DeploymentType (VIRTUAL_MACHINE|PHYSICAL_MACHINE) of these\nEdgeNodes is recommended to be the same. EdgeCluster supports members of different\ndeployment types.\n","parameters":[{"required":true,"type":"string","name":"edge-cluster-id","in":"path"},{"schema":{"$ref":"#/definitions/EdgeCluster"},"required":true,"name":"EdgeCluster","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Edge Clusters","Edge Clusters"],"summary":"Update Edge Cluster","x-vmw-nsx-module":"EdgeClusters","consumes":["application/json"],"operationId":"UpdateEdgeCluster"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Deletes the specified edge cluster.","parameters":[{"required":true,"type":"string","name":"edge-cluster-id","in":"path"}],"tags":["System Administration","Configuration","Fabric","Edge Clusters","Edge Clusters"],"summary":"Delete Edge Cluster","x-vmw-nsx-module":"EdgeClusters","consumes":["application/json"],"operationId":"DeleteEdgeCluster"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EdgeCluster"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about the specified edge cluster.","parameters":[{"required":true,"type":"string","name":"edge-cluster-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Edge Clusters","Edge Clusters"],"summary":"Read Edge Cluster","x-vmw-nsx-module":"EdgeClusters","consumes":["application/json"],"operationId":"ReadEdgeCluster"}},"/fabric/discovered-nodes/{node-ext-id}?action=create_transport_node":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TransportNode"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"NSX components are installaed on host and transport node is created with given configurations.","parameters":[{"required":true,"type":"string","name":"node-ext-id","in":"path"},{"schema":{"$ref":"#/definitions/TransportNode"},"required":true,"name":"TransportNode","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Discovered Nodes"],"summary":"Created Transport Node for Discovered Node","x-vmw-nsx-module":"TransportNodeLcm","consumes":["application/json"],"operationId":"CreateTransportNodeForDiscoveredNode"}},"/dns/forwarders/{forwarder-id}/state":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ConfigurationState"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Return the realized state information of a DNS forwarder.\nAfter a DNS forwarder was created or updated, you can invoke this API to\ncheck the realization state of the forwarder.\n","parameters":[{"required":true,"type":"string","name":"forwarder-id","in":"path"},{"name":"barrier_id","format":"int64","required":false,"minimum":0,"in":"query","type":"integer"},{"description":"Realization request ID","required":false,"type":"string","name":"request_id","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","DNS"],"summary":"Get the realized state of a DNS forwarder","x-vmw-nsx-module":"DnsForwarder","consumes":["application/json"],"operationId":"GetDnsForwarderState"}},"/logical-switches":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/LogicalSwitch"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Creates a new logical switch. The request must include the\ntransport_zone_id, display_name, and admin_state (UP or DOWN). The\nreplication_mode (MTEP or SOURCE) is required for overlay logical\nswitches, but not for VLAN-based logical switches. A vlan needs to be\nprovided for VLAN-based logical switches. This api is now deprecated.\nPlease use new api -/infra/segments/<segment-id>\n","parameters":[{"schema":{"$ref":"#/definitions/LogicalSwitch"},"required":true,"name":"LogicalSwitch","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Switching","Logical Switches"],"summary":"Create a Logical Switch","x-vmw-nsx-module":"LogicalSwitch","consumes":["application/json"],"operationId":"CreateLogicalSwitch"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LogicalSwitchListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about all configured logical switches. This api is now deprecated. Please use new api - /infra/segments","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Flag to enable showing of transit logical switch.","default":false,"required":false,"in":"query","type":"boolean","name":"diagnostic"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"enum":["DEFAULT","SERVICE_PLANE","DHCP_RELAY","GLOBAL","INTER_ROUTER","EVPN","DVPG"],"description":"Logical Switch type","required":false,"in":"query","type":"string","name":"switch_type"},{"description":"Switching Profile identifier","required":false,"type":"string","name":"switching_profile_id","in":"query"},{"enum":["OVERLAY","VLAN"],"description":"Mode of transport supported in the transport zone for this logical switch","required":false,"in":"query","type":"string","name":"transport_type"},{"description":"Transport zone identifier","required":false,"type":"string","name":"transport_zone_id","in":"query"},{"description":"The logical switch's uplink teaming policy name","required":false,"type":"string","name":"uplink_teaming_policy_name","in":"query"},{"description":"Virtual Local Area Network Identifier","format":"int64","required":false,"maximum":4094,"minimum":0,"in":"query","type":"integer","name":"vlan"},{"description":"VNI of the OVERLAY LogicalSwitch(es) to return.","format":"int32","required":false,"in":"query","type":"integer","name":"vni"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Switching","Logical Switches"],"summary":"List all Logical Switches","x-vmw-nsx-module":"LogicalSwitch","consumes":["application/json"],"operationId":"ListLogicalSwitches"}},"/transport-nodes/{transport-node-id}/capabilities":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeCapabilitiesResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about capabilities of transport host node. Edge nodes do not have capabilities.","parameters":[{"required":true,"type":"string","name":"transport-node-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Transport Nodes"],"summary":"Return the list of capabilities of transport node","x-vmw-nsx-module":"TransportNodeLcm","consumes":["application/json"],"operationId":"ListTransportNodeCapabilities"}},"/node/network/name-servers":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeNameServersProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"409":{"description":"Conflict"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Modifies the list of servers that the node uses to look up IP\naddresses associated with given domain names. If DHCP is configured, this\nmethod returns a 409 CONFLICT error, because DHCP manages the list of name\nservers.\n","parameters":[{"schema":{"$ref":"#/definitions/NodeNameServersProperties"},"required":true,"name":"NodeNameServersProperties","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","DNS"],"summary":"Update the Node's Name Servers","x-vmw-nsx-module":"NodeNetworkDnsModule","consumes":["application/json"],"operationId":"UpdateNodeNameServers"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeNameServersProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the list of servers that the node uses to look up IP\naddresses associated with given domain names.\n","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","DNS"],"summary":"Read the Node's Name Servers","x-vmw-nsx-module":"NodeNetworkDnsModule","consumes":["application/json"],"operationId":"ReadNodeNameServers"}},"/configs/central-config/node-config-profiles/{node-config-profile-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/CentralNodeConfigProfile"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Updates properties in the specified Central Node Config profile.\n","parameters":[{"required":true,"type":"string","name":"node-config-profile-id","in":"path"},{"schema":{"$ref":"#/definitions/CentralNodeConfigProfile"},"required":true,"name":"CentralNodeConfigProfile","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Global Configurations"],"summary":"Configure Node Config profile","x-vmw-nsx-module":"CentralConfig","consumes":["application/json"],"operationId":"UpdateCentralNodeConfigProfile"}},"/node/services/migration-coordinator?action=start":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the migration coordinator service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Migration Coordinator Service"],"summary":"Restart, start or stop the migration coordinator service","x-vmw-nsx-module":"NodeMigrationCoordinatorService","consumes":["application/json"],"operationId":"CreateMigrationCoordinatorServiceActionStart"}},"/host-switch-profiles/{host-switch-profile-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BaseHostSwitchProfile"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Modifies a specified hostswitch profile. The body of the PUT request must\ninclude the resource_type. For uplink profiles, the put request must also\ninclude teaming parameters. Modifiable attributes include display_name, mtu,\nand transport_vlan. For uplink teaming policies, uplink_name and policy are\nalso modifiable.\nThis api is now deprecated. Please use new api -\nPATCH policy/api/v1/infra/host-switch-profiles/uplinkProfile1\n","parameters":[{"required":true,"type":"string","name":"host-switch-profile-id","in":"path"},{"schema":{"$ref":"#/definitions/BaseHostSwitchProfile"},"required":true,"name":"BaseHostSwitchProfile","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Profiles","Hostswitch Profiles"],"summary":"Update a Hostswitch Profile","x-vmw-nsx-module":"BaseHostSwitchProfile","consumes":["application/json"],"operationId":"UpdateHostSwitchProfile"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BaseHostSwitchProfile"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about a specified hostswitch profile. This api is now deprecated. Please use new api - policy/api/v1/infra/host-switch-profiles/uplinkProfile1","parameters":[{"required":true,"type":"string","name":"host-switch-profile-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Profiles","Hostswitch Profiles"],"summary":"Get a Hostswitch Profile by ID","x-vmw-nsx-module":"BaseHostSwitchProfile","consumes":["application/json"],"operationId":"GetHostSwitchProfile"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Deletes a specified hostswitch profile. This api is now deprecated. Please use new api - DELETE policy/api/v1/infra/host-switch-profiles/uplinkProfile1","parameters":[{"required":true,"type":"string","name":"host-switch-profile-id","in":"path"}],"tags":["System Administration","Configuration","Fabric","Profiles","Hostswitch Profiles"],"summary":"Delete a Hostswitch Profile","x-vmw-nsx-module":"BaseHostSwitchProfile","consumes":["application/json"],"operationId":"DeleteHostSwitchProfile"}},"/fabric/compute-collections":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ComputeCollectionListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about all compute collections.","parameters":[{"description":"Local Id of the compute collection in the Compute Manager","required":false,"type":"string","name":"cm_local_id","in":"query"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Id of the discovered node which belongs to this Compute Collection\n","required":false,"type":"string","name":"discovered_node_id","in":"query"},{"description":"Name of the ComputeCollection in source compute manager","required":false,"type":"string","name":"display_name","in":"query"},{"description":"External ID of the ComputeCollection in the source Compute manager,\ne.g. mo-ref in VC\n","required":false,"type":"string","name":"external_id","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Id of the fabric node created from a discovered node belonging to\nthis Compute Collection\n","required":false,"type":"string","name":"node_id","in":"query"},{"description":"Id of the compute manager from where this Compute Collection was discovered","required":false,"type":"string","name":"origin_id","in":"query"},{"description":"ComputeCollection type like VC_Cluster. Here the Compute Manager\ntype prefix would help in differentiating similar named Compute\nCollection types from different Compute Managers\n","required":false,"type":"string","name":"origin_type","in":"query"},{"description":"Id of the owner of compute collection in the Compute Manager","required":false,"type":"string","name":"owner_id","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Compute Collections"],"summary":"Return the List of Compute Collections","x-vmw-nsx-module":"InventoryCmObj","consumes":["application/json"],"operationId":"ListComputeCollections"}},"/nvds-urt/precheck-by-clusters":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NvdsUpgradePrecheckId"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Start precheck for N-VDS to VDS migration by clusters","parameters":[{"schema":{"$ref":"#/definitions/PrecheckParameters"},"required":true,"name":"PrecheckParameters","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Transport Nodes"],"summary":"Start precheck for N-VDS to VDS migration by clusters","x-vmw-nsx-module":"NvdsUpgradeReadinessCheck","consumes":["application/json"],"operationId":"CreateNvdsUpgradePrecheckByClusters"}},"/serviceinsertion/services/{service-id}/service-instances/{service-instance-id}/instance-runtimes?action=upgrade":{"post":{"responses":{"200":{"description":"OK"},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Upgrade service VMs using newer version of OVF.\nUpgrade is a 2 step process. Update the 'deployment_spec_name' in the\nServiceInstance to the new DeploymentSpec to which the service VMs will be\nupgraded, folowed by this 'upgrade' api.\nIn case of HA, the stand-by service VM will be upgrade first. Once it has been upgraded,\nit switches to be the Active one and then the other VM will be upgrade.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"required":true,"type":"string","name":"service-instance-id","in":"path"}],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Upgrade service VMs using newer version of OVF","x-vmw-nsx-module":"ServiceInsertionVMDeployment","consumes":["application/json"],"operationId":"UpgradeServiceVMs"}},"/cluster/node?action=repo_sync":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Attempts to synchronize the repository partition on nsx manager. Repository partition contains packages required for the\ninstall and upgrade of nsx components.Normally there is no need to call this API explicitely by the user.\n","tags":["System Administration","Configuration","NSX Managers","Clusters","Cluster Node Deployments"],"summary":"Synchronizes the repository data between nsx managers.","x-vmw-nsx-module":"ClusterNodeVMDeployment","consumes":["application/json"],"operationId":"PerformRepoSync"}},"/node/services/idps-reporting":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read the idps-reporting service properties","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Idps Reporting Service"],"summary":"Read the idps-reporting service properties","x-vmw-nsx-module":"IdpsReportingService","consumes":["application/json"],"operationId":"ReadIdpsReportingService"}},"/dhcp/relays/{relay-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DhcpRelayService"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Modifies the specified dhcp relay service.\n","parameters":[{"required":true,"type":"string","name":"relay-id","in":"path"},{"schema":{"$ref":"#/definitions/DhcpRelayService"},"required":true,"name":"DhcpRelayService","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","DHCP Relay"],"summary":"Update a DHCP Relay Service","x-vmw-nsx-module":"DhcpRelay","consumes":["application/json"],"operationId":"UpdateDhcpRelay"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Deletes the specified dhcp relay service.","parameters":[{"required":true,"type":"string","name":"relay-id","in":"path"}],"tags":["Management Plane API","Networking","Services","DHCP Relay"],"summary":"Delete a DHCP Relay Service","x-vmw-nsx-module":"DhcpRelay","consumes":["application/json"],"operationId":"DeleteDhcpRelay"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DhcpRelayService"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the dhcp relay service information.","parameters":[{"required":true,"type":"string","name":"relay-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","DHCP Relay"],"summary":"Read a DHCP Relay Service","x-vmw-nsx-module":"DhcpRelay","consumes":["application/json"],"operationId":"ReadDhcpRelay"}},"/node/services/http?action=start":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Start the http service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","HTTP Service"],"summary":"Start the http service","x-vmw-nsx-module":"NodeProxyService","consumes":["application/json"],"operationId":"CreateProxyServiceActionStartStart"}},"/vpn/l2vpn/sessions/{l2vpn-session-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/L2VpnSession"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Edit a specific L2VPN session","parameters":[{"required":true,"type":"string","name":"l2vpn-session-id","in":"path"},{"schema":{"$ref":"#/definitions/L2VpnSession"},"required":true,"name":"L2VpnSession","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","VPN","L2VPN","Sessions"],"summary":"Edit a L2VPN session","x-vmw-nsx-module":"L2VPN","consumes":["application/json"],"operationId":"UpdateL2VpnSession"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete a specific L2VPN session. If there are any logical switch ports attached to it, those needs to be deleted first.","parameters":[{"required":true,"type":"string","name":"l2vpn-session-id","in":"path"}],"tags":["Management Plane API","Networking","VPN","L2VPN","Sessions"],"summary":"Delete a L2VPN session","x-vmw-nsx-module":"L2VPN","consumes":["application/json"],"operationId":"DeleteL2VpnSession"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/L2VpnSession"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get a specific L2VPN session","parameters":[{"required":true,"type":"string","name":"l2vpn-session-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","VPN","L2VPN","Sessions"],"summary":"Get a L2VPN session","x-vmw-nsx-module":"L2VPN","consumes":["application/json"],"operationId":"GetL2VpnSession"}},"/migration/feedback-summary":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MigrationFeedbackSummaryListResult"}},"401":{"description":"Unauthorized"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get feedback summary of NSX-V to be migrated.\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"enum":["L2","L3_L7"],"description":"Network layer for which feedback is generated","required":false,"in":"query","type":"string","name":"network_layer"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Migration","Feedback"],"summary":"Feedback request summary","x-vmw-nsx-module":"Migration","consumes":["application/json"],"operationId":"GetFeedbackSummary"}},"/node?action=restart":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restarts or shuts down the NSX appliance.","tags":["System Administration","Configuration","Fabric","Nodes","Settings"],"summary":"Restart or shutdown node","x-vmw-nsx-module":"Node","consumes":["application/json"],"operationId":"RestartOrShutdownNodeRestart"}},"/node/network/interfaces/{interface-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeNetworkInterfaceProperties"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Updates the specified interface properties. You cannot change\nthe properties ip_configuration
,\nip_addresses
, or plane
. NSX\nManager must have a static IP address.\nYou must use NSX CLI to configure a controller or an edge node.\n","parameters":[{"description":"ID of interface to update","required":true,"type":"string","name":"interface-id","in":"path"},{"schema":{"$ref":"#/definitions/NodeNetworkInterfaceProperties"},"required":true,"name":"NodeNetworkInterfaceProperties","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Network Interfaces"],"summary":"Update the Node's Network Interface","x-vmw-nsx-module":"NetworkInterfaceModule","consumes":["application/json"],"operationId":"UpdateNodeInterface"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeNetworkInterfaceProperties"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns detailed information about the specified interface. Interface\ninformation includes MTU, broadcast and host IP addresses, link and admin\nstatus, MAC address, network mask, and the IP configuration method.\n","parameters":[{"description":"ID of interface to read","required":true,"type":"string","name":"interface-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Network Interfaces"],"summary":"Read the Node's Network Interface","x-vmw-nsx-module":"NetworkInterfaceModule","consumes":["application/json"],"operationId":"ReadNodeInterface"}},"/node/services/ssh":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeSshServiceProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update ssh service properties. If the start_on_boot property is updated to true, existing ssh sessions if any are stopped and the ssh service is restarted.","parameters":[{"schema":{"$ref":"#/definitions/NodeSshServiceProperties"},"required":true,"name":"NodeSshServiceProperties","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","SSH"],"summary":"Update ssh service properties","x-vmw-nsx-module":"NodeSSHService","consumes":["application/json"],"operationId":"UpdateSSHService"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeSshServiceProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read ssh service properties","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","SSH"],"summary":"Read ssh service properties","x-vmw-nsx-module":"NodeSSHService","consumes":["application/json"],"operationId":"ReadSSHService"}},"/traceflows":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/Traceflow"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Initiate a Traceflow Operation on the Specified Port","parameters":[{"schema":{"$ref":"#/definitions/TraceflowRequest"},"required":true,"name":"TraceflowRequest","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Troubleshooting And Monitoring","Traceflow"],"summary":"Initiate a Traceflow Operation on the Specified Port","x-vmw-nsx-module":"Traceflow","consumes":["application/json"],"operationId":"CreateTraceflow"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TraceflowListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"List all Traceflow rounds; if a logical port id is given as a query parameter,\nonly those originated from the logical port are returned.\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"id of the source logical port where the trace flows originated","required":false,"type":"string","name":"lport_id","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Troubleshooting And Monitoring","Traceflow"],"summary":"List all Traceflow rounds","x-vmw-nsx-module":"Traceflow","consumes":["application/json"],"operationId":"ListTraceflows"}},"/fabric/container-ingress-policies":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ContainerIngressPolicyListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about all ingress policies.","parameters":[{"description":"Identifier of the container cluster","required":false,"type":"string","name":"container_cluster_id","in":"query"},{"description":"Identifier of the container project","required":false,"type":"string","name":"container_project_id","in":"query"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"description":"Scope id for container cluster","required":false,"type":"string","name":"scope_id","in":"query"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Policy","Inventory","Containers","Container Clusters"],"summary":"Return the List of Container Ingress Policies","x-vmw-nsx-module":"InventoryContainerObj","consumes":["application/json"],"operationId":"ListContainerIngressPolicies"}},"/firewall/sections/{section-id}?action=update_with_rules":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FirewallSectionRuleList"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Modifies existing firewall section along with its association with rules.\nWhen invoked on a large number of rules, this API is supported only at low\nrates of invocation (not more than 2 times per minute). The typical latency\nof this API with about 1024 rules is about 15 seconds in a cluster setup.\nThis API should not be invoked with large payloads at automation speeds.\n\nInstead, to update rule content, use:\nPUT /api/v1/firewall/sections/<section-id>/rules/<rule-id>\n\nSimultaneous update (modify) operations on same section are not allowed to\nprevent overwriting stale contents to firewall section. If a concurrent\nupdate is performed, HTTP response code 409 will be returned to the client\noperating on stale data. That client should retrieve the firewall section\nagain and re-apply its update.\n","parameters":[{"required":true,"type":"string","name":"section-id","in":"path"},{"schema":{"$ref":"#/definitions/FirewallSectionRuleList"},"required":true,"name":"FirewallSectionRuleList","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Firewall"],"summary":"Update an Existing Section, Including Its Rules","x-vmw-nsx-module":"Firewall","consumes":["application/json"],"operationId":"UpdateSectionWithRules"}},"/trust-management/certificates/{cert-id}?action=apply_certificate":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Look up the Certificate Profile matching the service-type and apply the certificate.\nWhen the Certificate Profile has cluster_certificate=false, the node_id parameter\nis required to designate the node where the certificate needs to be applied.\n","parameters":[{"description":"ID of certificate to apply","required":true,"type":"string","name":"cert-id","in":"path"},{"in":"query","description":"Node Id","required":false,"maxLength":255,"type":"string","name":"node_id"},{"enum":["MGMT_CLUSTER","MGMT_PLANE","API","NOTIFICATION_COLLECTOR","SYSLOG_SERVER","RSYSLOG_CLIENT","APH","GLOBAL_MANAGER","LOCAL_MANAGER","CLIENT_AUTH","RMQ","K8S_MSG_CLIENT"],"description":"Supported service types, that are using certificates.","required":true,"in":"query","type":"string","name":"service_type"}],"summary":"Apply a certificate for a CertificateProfile","x-vmw-nsx-module":"CertificateManager","consumes":["application/json"],"operationId":"ApplyCertificate"}},"/node/logs":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeLogPropertiesListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the number of log files and lists the log files that reside on the\nNSX virtual appliance. The list includes the filename, file size,\nand last-modified time in milliseconds since epoch (1 January 1970) for each\nlog file. Knowing the last-modified time with millisecond accuracy since\nepoch is helpful when you are comparing two times, such as the time of a\nPOST request and the end time on a server.\n","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Logs"],"summary":"List available node logs","x-vmw-nsx-module":"NodeLogs","consumes":["application/json"],"operationId":"ListNodeLogs"}},"/node/tasks/{task-id}":{"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"409":{"description":"Conflict"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete task","parameters":[{"description":"ID of task to delete","required":true,"type":"string","name":"task-id","in":"path"}],"tags":["System Administration","Configuration","Fabric","Nodes","Services","Tasks"],"summary":"Delete task","x-vmw-nsx-module":"ApplianceManagementTaskModule","consumes":["application/json"],"operationId":"DeleteApplianceManagementTask"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ApplianceManagementTaskProperties"}},"303":{"description":"See Other","schema":{"$ref":"#/definitions/ApplianceManagementTaskProperties"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read task properties","parameters":[{"description":"ID of task to read","required":true,"type":"string","name":"task-id","in":"path"},{"default":false,"description":"Suppress redirect status if applicable","type":"boolean","name":"suppress_redirect","in":"query"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","Tasks"],"summary":"Read task properties","x-vmw-nsx-module":"ApplianceManagementTaskModule","consumes":["application/json"],"operationId":"ReadApplianceManagementTaskProperties"}},"/migration/plan?action=abort":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Resets all migration steps done so far, so that migration can be restarted\nwith new setup details.\n","tags":["System Administration","Lifecycle Management","Migration","Plan"],"summary":"Abort migration","x-vmw-nsx-module":"Migration","consumes":["application/json"],"operationId":"AbortMigration"}},"/licenses/{license-key}":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/License"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Deprecated. Use GET /licenses API instead.","parameters":[{"required":true,"type":"string","name":"license-key","in":"path"}],"produces":["application/json"],"tags":["System Administration","Settings","Licenses"],"summary":"Deprecated. Get license properties for license identified by the license-key","x-vmw-nsx-module":"License","consumes":["application/json"],"operationId":"GetLicenseByKey"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Deprecated. Use POST /licenses?action=delete API instead.\n","parameters":[{"required":true,"type":"string","name":"license-key","in":"path"}],"tags":["System Administration","Settings","Licenses"],"summary":"Deprecated. Remove a license identified by the license-key","x-vmw-nsx-module":"License","consumes":["application/json"],"operationId":"DeleteLicense"}},"/licenses/licenses-usage":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FeatureUsageList"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns usage report of all registered modules\n","produces":["application/json"],"tags":["System Administration","Settings","Licenses"],"summary":"Get usage report of all registered modules","x-vmw-nsx-module":"License","consumes":["application/json"],"operationId":"GetLicenseUsageReport"}},"/aaa/vidm/groups":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/VidmInfoListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"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. This API will return as many results that vIDM returns to NSX during the search query. vIDM may not send all results at once so to zero in on the group of interest more characters need to be entered.","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"description":"Search string to search for.\n","required":true,"type":"string","name":"search_string","in":"query"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["System Administration","Settings","User Management","VIDM Configuration"],"summary":"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. This API will return as many results that vIDM returns to NSX during the search query. vIDM may not send all results at once so to zero in on the group of interest more characters need to be entered.","x-vmw-nsx-module":"AAA","consumes":["application/json"],"operationId":"GetGroupVidmSearchResult"}},"/logical-ports":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/LogicalPort"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Creates a new logical switch port. The required parameters are the\nassociated logical_switch_id and admin_state (UP or DOWN). Optional\nparameters are the attachment and switching_profile_ids. If you don't\nspecify switching_profile_ids, default switching profiles are assigned to\nthe port. If you don't specify an attachment, the switch port remains\nempty. To configure an attachment, you must specify an id, and\noptionally you can specify an attachment_type (VIF or LOGICALROUTER).\nThe attachment_type is VIF by default. This api is now deprecated. Please use new api -\nPUT /infra/segments/<segment-id>/ports/<port-id>\n","parameters":[{"schema":{"$ref":"#/definitions/LogicalPort"},"required":true,"name":"LogicalPort","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Switching","Logical Switch Ports"],"summary":"Create a Logical Port","x-vmw-nsx-module":"LogicalPort","consumes":["application/json"],"operationId":"CreateLogicalPort"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LogicalPortListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about all configured logical switch ports. Logical\nswitch ports connect to VM virtual network interface cards (NICs). Each\nlogical port is associated with one logical switch.\nThis api is now deprecated. Please use new api -\n/infra/segments/<segment-id>/ports\n","parameters":[{"description":"Logical Port attachment Id","required":false,"type":"string","name":"attachment_id","in":"query"},{"enum":["VIF","LOGICALROUTER","BRIDGEENDPOINT","DHCP_SERVICE","METADATA_PROXY","L2VPN_SESSION","NONE"],"description":"Type of attachment for logical port; for query only.","required":false,"in":"query","type":"string","name":"attachment_type"},{"description":"Bridge Cluster identifier","required":false,"type":"string","name":"bridge_cluster_id","in":"query"},{"description":"Only container VIF logical ports will be returned if true","default":false,"required":false,"in":"query","type":"boolean","name":"container_ports_only"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Flag to enable showing of transit logical port.","default":false,"required":false,"in":"query","type":"boolean","name":"diagnostic"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Logical Switch identifier","required":false,"type":"string","name":"logical_switch_id","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"description":"ID of the VIF of type PARENT","required":false,"type":"string","name":"parent_vif_id","in":"query"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"description":"Network Profile identifier","required":false,"type":"string","name":"switching_profile_id","in":"query"},{"description":"Transport node identifier","required":false,"type":"string","name":"transport_node_id","in":"query"},{"description":"Transport zone identifier","required":false,"type":"string","name":"transport_zone_id","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Switching","Logical Switch Ports"],"summary":"List All Logical Ports","x-vmw-nsx-module":"LogicalPort","consumes":["application/json"],"operationId":"ListLogicalPorts"}},"/logical-router-ports/{logical-router-port-id}/state":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LogicalRouterPortState"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Return realized state information of a logical router port.\nAny configuration update that affects the logical router port can use this API\nto get its realized state by passing a request_id returned by the\nconfiguration change operation. e.g. Update configuration of logical router ports,\ndhcp relays, etc.\n","parameters":[{"required":true,"type":"string","name":"logical-router-port-id","in":"path"},{"name":"barrier_id","format":"int64","required":false,"minimum":0,"in":"query","type":"integer"},{"description":"Realization request ID","required":false,"type":"string","name":"request_id","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Logical Router Ports"],"summary":"Get the Realized State of a Logical Router Port","x-vmw-nsx-module":"LogicalRouterPorts","consumes":["application/json"],"operationId":"GetLogicalRouterPortState"}},"/cluster?action=summarize_inventory_to_remote":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Request one-time inventory summary. The backup will be uploaded using the\nsame server configuration as for an automatic backup.\n","tags":["System Administration","Lifecycle Management","Backup Restore Management","Backup"],"summary":"Request one-time inventory summary.","x-vmw-nsx-module":"BackupConfiguration","consumes":["application/json"],"operationId":"RequestOnetimeInventorySummary"}},"/logical-routers/{logical-router-id}/routing/static-routes/{id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/StaticRoute"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update a specific static route on the specified logical router.\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"required":true,"type":"string","name":"id","in":"path"},{"schema":{"$ref":"#/definitions/StaticRoute"},"required":true,"name":"StaticRoute","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Routing Configuration"],"summary":"Update a specific Static Route Rule on a Logical Router","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"UpdateStaticRoute"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/StaticRoute"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read a specific static routes on the specified logical router.\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"required":true,"type":"string","name":"id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Routing Configuration"],"summary":"Get a specific Static Route on a Logical Router","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"ReadStaticRoute"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Deletes a specific static route on the specified logical router.\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"required":true,"type":"string","name":"id","in":"path"}],"tags":["Management Plane API","Networking","Logical Routing And Services","Routing Configuration"],"summary":"Delete a specific Static Route on a Logical Router","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"DeleteStaticRoute"}},"/logical-ports/{lport-id}/state":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LogicalPortState"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns transport node id for a specified logical port. Also returns\ninformation about all address bindings of the specified logical port. This\nincludes address bindings discovered via various snooping methods like ARP\nsnooping, DHCP snooping etc. and addressing bindings that are realized\nbased on user configuration. This api is now deprecated. Please use new api -\nGET policy/api/v1/infra/realized-state/realized-entities?intent_path={{intent-path}}\nGET policy/api/v1/infra/realized-state/status?intent_path={{intent-path}}\n","parameters":[{"required":true,"type":"string","name":"lport-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Switching","Logical Switch Ports"],"summary":"Get realized state & location of a logical port","x-vmw-nsx-module":"LogicalPort","consumes":["application/json"],"operationId":"GetLogicalPortState"}},"/repository/bundles/ovf-deploy-info":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/OvfInfo"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get information of the OVF for specified appliance which is\npresent in repository and will be used to deploy new VM.\n","parameters":[{"enum":["SAMPLE","ALB_CONTROLLER","INTELLIGENCE"],"description":"Name of the appliance","required":true,"in":"query","type":"string","name":"product"}],"produces":["application/json"],"tags":["System Administration","Configuration","NSX Intelligence","Repository","Bundles"],"summary":"Get information of the OVF which will be getting deployed.\n","x-vmw-nsx-module":"FileUploadFramework","consumes":["application/json"],"operationId":"GetOvfDeployInfo"}},"/node/tasks/{task-id}/response":{"get":{"responses":{"201":{"description":"Created"},"200":{"description":"OK"},"202":{"description":"Accepted"},"204":{"description":"No Content"},"303":{"description":"See Other"},"404":{"description":"Not Found"},"410":{"description":"Gone"},"500":{"$ref":"#/responses/InternalServerError"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"403":{"$ref":"#/responses/Forbidden"},"502":{"description":"Bad Gateway"},"503":{"$ref":"#/responses/ServiceUnavailable"},"409":{"description":"Conflict"}},"description":"Read asynchronous task response","parameters":[{"description":"ID of task to read","required":true,"type":"string","name":"task-id","in":"path"}],"tags":["System Administration","Configuration","Fabric","Nodes","Services","Tasks"],"summary":"Read asynchronous task response","x-vmw-nsx-module":"ApplianceManagementTaskModule","consumes":["application/json"],"operationId":"ReadAsyncApplianceManagementTaskResponse"}},"/upgrade?action=execute_pre_upgrade_checks":{"post":{"responses":{"202":{"description":"Accepted"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"description":"Internal Server Error"}},"description":"Run pre-defined checks to identify potential issues which can be\nencountered during an upgrade or can cause an upgrade to fail. The results\nof the checks are added to the respective upgrade units aggregate-info. The\nprogress and status of operation is part of upgrade status summary of\nindividual components.\nReturns HTTP status 500 with error code 30953 if execution of pre-upgrade\nchecks is already in progress.\n","parameters":[{"description":"Component type on which the action is performed or on which the results are filtered","required":false,"type":"string","name":"component_type","in":"query"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"tags":["System Administration","Lifecycle Management","Upgrade","Plan"],"summary":"Execute pre-upgrade checks","x-vmw-nsx-module":"Upgrade","consumes":["application/json"],"operationId":"ExecutePreUpgradeChecks"}},"/sites/compatibility":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SiteCompatibilityInfo"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"description":"Service Unavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the version of this site and list of compatible versions\n","produces":["application/json"],"tags":["System Administration","Configuration","Site Management"],"summary":"Get the compatibility list of the site","x-vmw-nsx-module":"SiteManagerModule","consumes":["application/json"],"operationId":"CompatibleList"}},"/node/services/cluster_manager?action=stop":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the cluster boot manager service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Cluster Manager Service"],"summary":"Restart, start or stop the cluster boot manager service","x-vmw-nsx-module":"NodeClusterBootManagerService","consumes":["application/json"],"operationId":"CreateClusterBootManagerServiceActionStop"}},"/cluster/backups/history":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BackupOperationHistory"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get history of previous backup operations\n","produces":["application/json"],"tags":["System Administration","Lifecycle Management","Backup Restore Management","Backup"],"summary":"Get backup history","x-vmw-nsx-module":"BackupConfiguration","consumes":["application/json"],"operationId":"GetBackupHistory"}},"/ns-groups/{ns-group-id}/effective-cloud-native-service-instance-members":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EffectiveMemberResourceListResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns effective cloud native service instances of the specified NSGroup.\nThis API is applicable only for NSGroups containing CloudNativeServiceInstance member type.\nFor NSGroups containing other member types,it returns an empty list. target_id in response\nis external_id of CloudNativeServiceInstance\n","parameters":[{"description":"NSGroup Id","required":true,"type":"string","name":"ns-group-id","in":"path"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Grouping Objects","NS Groups"],"summary":"Get Effective Cloud Native Service Instances of the specified NSGroup.","x-vmw-nsx-module":"NSGroup","consumes":["application/json"],"operationId":"GetEffectiveCloudNativeServiceInstances"}},"/bridge-endpoints/{bridgeendpoint-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BridgeEndpoint"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Modifies a existing bridge endpoint.\n","parameters":[{"required":true,"type":"string","name":"bridgeendpoint-id","in":"path"},{"schema":{"$ref":"#/definitions/BridgeEndpoint"},"required":true,"name":"BridgeEndpoint","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Bridging","Bridge Endpoints"],"summary":"Update a Bridge Endpoint","x-vmw-nsx-module":"BridgeEndpoint","consumes":["application/json"],"operationId":"UpdateBridgeEndpoint"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BridgeEndpoint"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about a specified bridge endpoint.","parameters":[{"required":true,"type":"string","name":"bridgeendpoint-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Bridging","Bridge Endpoints"],"summary":"Get Information about a bridge endpoint","x-vmw-nsx-module":"BridgeEndpoint","consumes":["application/json"],"operationId":"GetBridgeEndpoint"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Deletes the specified Bridge Endpoint.","parameters":[{"required":true,"type":"string","name":"bridgeendpoint-id","in":"path"}],"tags":["Management Plane API","Networking","Logical Bridging","Bridge Endpoints"],"summary":"Delete a Bridge Endpoint","x-vmw-nsx-module":"BridgeEndpoint","consumes":["application/json"],"operationId":"DeleteBridgeEndpoint"}},"/cluster?action=backup_to_remote":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Request one-time backup. The backup will be uploaded using the\nsame server configuration as for automatic backup.\n","parameters":[{"enum":["GLOBAL_MANAGER","LOCAL_MANAGER","LOCAL_LOCAL_MANAGER","NSX_INTELLIGENCE"],"description":"Frame type","default":"LOCAL_LOCAL_MANAGER","required":false,"in":"query","type":"string","name":"frame_type"},{"description":"Site ID","default":"localhost","required":false,"in":"query","type":"string","name":"site_id"}],"tags":["System Administration","Lifecycle Management","Backup Restore Management","Backup"],"summary":"Request one-time backup","x-vmw-nsx-module":"BackupConfiguration","consumes":["application/json"],"operationId":"RequestOnetimeBackup"}},"/cluster/backups/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/CurrentBackupOperationStatus"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get status of active backup operations\n","produces":["application/json"],"tags":["System Administration","Lifecycle Management","Backup Restore Management","Backup"],"summary":"Get backup status","x-vmw-nsx-module":"BackupConfiguration","consumes":["application/json"],"operationId":"GetBackupStatus"}},"/migration/status-summary":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MigrationStatus"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get migration status summary","parameters":[{"description":"Component type based on which migration units to be filtered","required":false,"type":"string","name":"component_type","in":"query"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Migration","Status"],"summary":"Get migration status summary","x-vmw-nsx-module":"Migration","consumes":["application/json"],"operationId":"GetMigrationStatusSummary"}},"/upgrade/version-whitelist/{component_type}":{"put":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update the version whitelist for the specified component type (HOST, EDGE, CCP, MP).","parameters":[{"required":true,"type":"string","name":"component_type","in":"path"},{"schema":{"$ref":"#/definitions/VersionList"},"required":true,"name":"VersionList","in":"body"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Upgrade","Nodes"],"summary":"Update the version whitelist for the specified component type","x-vmw-nsx-module":"VersionWhitelist","consumes":["application/json"],"operationId":"UpdateVersionWhitelist"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AcceptableComponentVersion"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get whitelist of versions for a component. Component can include HOST, EDGE, CCP, MP","parameters":[{"required":true,"type":"string","name":"component_type","in":"path"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Upgrade","Nodes"],"summary":"Get the version whitelist for the specified component","x-vmw-nsx-module":"VersionWhitelist","consumes":["application/json"],"operationId":"GetVersionWhitelistByComponent"}},"/node/services/telemetry?action=stop":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop Telemetry service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Telemetry Service"],"summary":"Restart, start or stop Telemetry service","x-vmw-nsx-module":"NodePhonehomeCoordinatorService","consumes":["application/json"],"operationId":"CreatePhonehomeCoordinatorServiceActionStop"}},"/sites?version=3.1.0":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FederationConfiguration"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"description":"Service Unavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get the site configuration, some attributes won't be shown based on version","produces":["application/json"],"tags":["System Administration","Configuration","Site Management"],"summary":"Get the site configuration, some attributes won't be shown based on version","x-vmw-nsx-module":"SiteManagerModule","consumes":["application/json"],"operationId":"GetSiteConfigurationVersioned310"}},"/dhcp/servers/{server-id}/state":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ConfigurationState"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Return realized state information of a dhcp server.\nAfter a dhcp server is created or updated, you can invoke this API to get\nthe realization information of the server.\n","parameters":[{"required":true,"type":"string","name":"server-id","in":"path"},{"name":"barrier_id","format":"int64","required":false,"minimum":0,"in":"query","type":"integer"},{"description":"Realization request ID","required":false,"type":"string","name":"request_id","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","DHCP"],"summary":"Get the realized state of a dhcp server","x-vmw-nsx-module":"Dhcp","consumes":["application/json"],"operationId":"GetDhcpServerState"}},"/intrusion-services/ids-events":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IDSEventsBySignatureResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"description":"Bad Request"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get the list of the IDS events that are detected with the total number of\nintrusions detected, their severity and the time they occurred,\ngrouped by signature id.\n","parameters":[{"schema":{"$ref":"#/definitions/IDSEventDataRequest"},"required":true,"name":"IDSEventDataRequest","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Security","Intrusion Services","Dashboard"],"summary":"Get the list of the IDS events that are detected, grouped by signature id.","x-vmw-nsx-module":"IDSMetrics","consumes":["application/json"],"operationId":"GetAllIdsEvents"}},"/node/logs/{log-name}":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeLogProperties"}},"206":{"description":"Partial Content","schema":{"$ref":"#/definitions/NodeLogProperties"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"For a single specified log file, lists the filename, file size, and\nlast-modified time.\n","parameters":[{"description":"Name of log file to read properties","required":true,"type":"string","name":"log-name","in":"path"}],"produces":["application/json","application/octet-stream"],"tags":["System Administration","Configuration","Fabric","Nodes","Logs"],"summary":"Read node log properties","x-vmw-nsx-module":"NodeLogs","consumes":["application/json"],"operationId":"ReadNodeLog"}},"/search/query":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SearchResponse"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"description":"Bad Request"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Full text search API","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"description":"Search query","required":true,"type":"string","name":"query","in":"query"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Search","Search API"],"summary":"Full text search API","x-vmw-nsx-module":"Search","consumes":["application/json"],"operationId":"QuerySearch"}},"/upgrade/plan?action=stage-upgrade":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"description":"Internal Server Error"}},"description":"This will stage the upgrade bits so that upgrade can be driven\nfrom outside NSX upgrade-coordinator. If component type is not\nprovided as a request parameter then upgrade staging will be\nperformed on all the components.\n","parameters":[{"description":"Component type","required":false,"type":"string","name":"component_type","in":"query"}],"tags":["System Administration","Lifecycle Management","Upgrade","Plan"],"summary":"Stage the upgrade bits","x-vmw-nsx-module":"Upgrade","consumes":["application/json"],"operationId":"StageUpgrade"}},"/serviceinsertion/sections/{section-id}?action=revise_with_rules":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ServiceInsertionSectionRuleList"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Modifies an existing serviceinsertion section along with its relative position\namong other serviceinsertion sections with rules. When invoked on a large number\nof rules, this API is supported only at low rates of invocation (not more\nthan 2 times per minute). The typical latency of this API with about 1024\nrules is about 15 seconds in a cluster setup. This API should not be\ninvoked with large payloads at automation speeds.\n\nInstead, to move a section above or below another section, use:\nPOST /api/v1/serviceinsertion/sections/<section-id>?action=revise\n\nTo modify rules, use:\nPUT /api/v1/serviceinsertion/sections/<section-id>/rules/<rule-id>\nNote- POST service insertion section API is deprecated.\nPlease use policy redirection-policy API.\n","parameters":[{"required":true,"type":"string","name":"section-id","in":"path"},{"schema":{"$ref":"#/definitions/ServiceInsertionSectionRuleList"},"required":true,"name":"ServiceInsertionSectionRuleList","in":"body"},{"in":"query","description":"Identifier of the anchor rule or section. This is a required field in case operation like 'insert_before' and 'insert_after'.","required":false,"maxLength":64,"type":"string","name":"id"},{"enum":["insert_top","insert_bottom","insert_after","insert_before"],"description":"Operation","default":"insert_top","required":false,"in":"query","type":"string","name":"operation"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Update an Existing Section with Rules","x-vmw-nsx-module":"ServiceInsertionRules","consumes":["application/json"],"operationId":"ReviseServiceInsertionSectionWithRules"}},"/transport-node-collections":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/TransportNodeCollection"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"When transport node collection is created the hosts which are part\nof compute collection will be prepared automatically i.e. NSX Manager\nattempts to install the NSX components on hosts. Transport nodes for these\nhosts are created using the configuration specified in transport node\nprofile.\n","parameters":[{"schema":{"$ref":"#/definitions/TransportNodeCollection"},"required":true,"name":"TransportNodeCollection","in":"body"},{"description":"Indicates if the Transport Node Profile (TNP) configuration should be applied during creation","default":true,"required":false,"in":"query","type":"boolean","name":"apply_profile"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Transport Node Collections"],"summary":"Create transport node collection by attaching Transport Node Profile to cluster.","x-vmw-nsx-module":"TransportNodeCollection","consumes":["application/json"],"operationId":"CreateTransportNodeCollection"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TransportNodeCollectionListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns all Transport Node collections","parameters":[{"description":"Managed object ID of cluster in VC","required":false,"type":"string","name":"cluster_moid","in":"query"},{"description":"Compute collection id","required":false,"type":"string","name":"compute_collection_id","in":"query"},{"description":"UUID for VC deployment","required":false,"type":"string","name":"vc_instance_uuid","in":"query"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Transport Node Collections"],"summary":"List Transport Node collections","x-vmw-nsx-module":"TransportNodeCollection","consumes":["application/json"],"operationId":"ListTransportNodeCollections"}},"/serviceinsertion/sections/{section-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ServiceInsertionSection"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Modifies the specified section, but does not modify the section's associated rules.\nNote- PUT service insertion section API is deprecated.\nPlease use policy redirection-policy API.\n","parameters":[{"required":true,"type":"string","name":"section-id","in":"path"},{"schema":{"$ref":"#/definitions/ServiceInsertionSection"},"required":true,"name":"ServiceInsertionSection","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Update an Existing Section","x-vmw-nsx-module":"ServiceInsertionRules","consumes":["application/json"],"operationId":"UpdateServiceInsertionSection"},"delete":{"responses":{"200":{"description":"OK"},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Removes serviceinsertion section from the system. ServiceInsertion section with\nrules can only be deleted by passing \"cascade=true\" parameter.\nNote- DELETE service insertion section API is deprecated.\nPlease use policy redirection-policy API.\n","parameters":[{"required":true,"type":"string","name":"section-id","in":"path"},{"description":"Flag to cascade delete of this object to all it's child objects.","default":false,"required":false,"in":"query","type":"boolean","name":"cascade"}],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Delete an Existing Section and Its Associated Rules","x-vmw-nsx-module":"ServiceInsertionRules","consumes":["application/json"],"operationId":"DeleteServiceInsertionSection"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ServiceInsertionSection"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about serviceinsertion section for the identifier.\nNote- GET service insertion section API is deprecated.\nPlease use policy redirection-policy API.\n","parameters":[{"required":true,"type":"string","name":"section-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Get an Existing Section","x-vmw-nsx-module":"ServiceInsertionRules","consumes":["application/json"],"operationId":"GetServiceInsertionSection"}},"/cluster/api-virtual-ip":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ClusterVirtualIpProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the configured cluster virtual IP address or null if not configured.\n","produces":["application/json"],"tags":["System Administration","Configuration","NSX Managers","Clusters","Cluster Virtual IP"],"summary":"Read cluster virtual IP address","x-vmw-nsx-module":"ClusterVirtualIp","consumes":["application/json"],"operationId":"GetClusterVirtualIp"}},"/ipfix/configs/{config-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IpfixConfig"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update an existing IPFIX configuration","parameters":[{"required":true,"type":"string","name":"config-id","in":"path"},{"schema":{"$ref":"#/definitions/IpfixConfig"},"required":true,"name":"IpfixConfig","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Troubleshooting And Monitoring","IPFIX"],"summary":"Update an existing IPFIX configuration","x-vmw-nsx-module":"Ipfix","consumes":["application/json"],"operationId":"UpdateIpfixConfig"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete an existing IPFIX configuration","parameters":[{"required":true,"type":"string","name":"config-id","in":"path"}],"tags":["Management Plane API","Troubleshooting And Monitoring","IPFIX"],"summary":"Delete an existing IPFIX configuration","x-vmw-nsx-module":"Ipfix","consumes":["application/json"],"operationId":"DeleteIpfixConfig"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IpfixConfig"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get an existing IPFIX configuration","parameters":[{"required":true,"type":"string","name":"config-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Troubleshooting And Monitoring","IPFIX"],"summary":"Get an existing IPFIX configuration","x-vmw-nsx-module":"Ipfix","consumes":["application/json"],"operationId":"GetIpfixConfig"}},"/vpn/ipsec/peer-endpoints/{ipsec-vpn-peer-endpoint-id}?action=show-sensitive-data":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IPSecVPNPeerEndpoint"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get custom IPSec VPN peer endpoint with PSK.","parameters":[{"required":true,"type":"string","name":"ipsec-vpn-peer-endpoint-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","VPN","IPSEC","Peer Endpoints"],"summary":"Get IPSec VPN peer endpoint with PSK","x-vmw-nsx-module":"IPSecVPN","consumes":["application/json"],"operationId":"GetIPSecVPNPeerEndpointWithPSK"}},"/ns-service-groups":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/NSServiceGroup"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Creates a new NSServiceGroup which can contain NSServices.\nA given NSServiceGroup can contain either only ether type of NSServices\nor only non-ether type of NSServices, i.e. an NSServiceGroup cannot\ncontain a mix of both ether and non-ether types of NSServices.\n","parameters":[{"schema":{"$ref":"#/definitions/NSServiceGroup"},"required":true,"name":"NSServiceGroup","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Grouping Objects","NS Services"],"summary":"Create NSServiceGroup","x-vmw-nsx-module":"NSServiceGroup","consumes":["application/json"],"operationId":"CreateNSServiceGroup"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NSServiceGroupListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns paginated list of NSServiceGroups\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Fetch all default NSServiceGroups","type":"boolean","name":"default_service","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Grouping Objects","NS Service Groups"],"summary":"List all NSServiceGroups","x-vmw-nsx-module":"NSServiceGroup","consumes":["application/json"],"operationId":"ListNSServiceGroups"}},"/dhcp/servers/{server-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LogicalDhcpServer"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update a logical DHCP server with new configurations.","parameters":[{"required":true,"type":"string","name":"server-id","in":"path"},{"schema":{"$ref":"#/definitions/LogicalDhcpServer"},"required":true,"name":"LogicalDhcpServer","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","DHCP"],"summary":"Update a DHCP server with v4 and/or v6 servers","x-vmw-nsx-module":"Dhcp","consumes":["application/json"],"operationId":"UpdateDhcpServer"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete a logical DHCP server specified by server id.","parameters":[{"required":true,"type":"string","name":"server-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","DHCP"],"summary":"Delete a DHCP server","x-vmw-nsx-module":"Dhcp","consumes":["application/json"],"operationId":"DeleteDhcpServer"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LogicalDhcpServer"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Retrieve a logical DHCP server specified by server id.","parameters":[{"required":true,"type":"string","name":"server-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","DHCP"],"summary":"Get a DHCP server with v4 and/or v6 servers","x-vmw-nsx-module":"Dhcp","consumes":["application/json"],"operationId":"ReadDhcpServer"}},"/service-configs/effective-profiles":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EffectiveProfileListResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the effective profiles applied to the specified Resource.\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"description":"Fetch effectivw profiles of the given profile_type","required":false,"type":"string","name":"profile_type","in":"query"},{"description":"The resource for which the effective profiles are to be fetched","required":true,"type":"string","name":"resource_id","in":"query"},{"enum":["NSGroup","LogicalPort","VirtualMachine","TransportNode","LogicalRouter","LogicalSwitch"],"description":"Valid Resource type in effective profiles API","required":true,"in":"query","type":"string","name":"resource_type"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Security","Service Configuration"],"summary":"Get Effective Profiles for an Entity","x-vmw-nsx-module":"ServiceConfig","consumes":["application/json"],"operationId":"EffectiveProfiles"}},"/vpn/l2vpn/sessions":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/L2VpnSession"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Create L2VPN session and bind to a L2VPNService","parameters":[{"schema":{"$ref":"#/definitions/L2VpnSession"},"required":true,"name":"L2VpnSession","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","VPN","L2VPN","Sessions"],"summary":"Create L2VPN session","x-vmw-nsx-module":"L2VPN","consumes":["application/json"],"operationId":"CreateL2VpnSession"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/L2VpnSessionListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get paginated list of all L2VPN sessions","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Id of the L2Vpn Service","required":false,"type":"string","name":"l2vpn_service_id","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","VPN","L2VPN","Sessions"],"summary":"Get all L2VPN sessions","x-vmw-nsx-module":"L2VPN","consumes":["application/json"],"operationId":"ListL2VpnSessions"}},"/node/services/nsx-upgrade-agent/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read Nsx upgrade agent service status","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","Upgrade Agent"],"summary":"Read Nsx upgrade agent service status","x-vmw-nsx-module":"NodeNsxUpgradeAgent","consumes":["application/json"],"operationId":"ReadNsxUpgradeAgentServiceStatus"}},"/livetraces/{livetrace-session-id}/proxy/reverse/capturefile":{"get":{"responses":{"200":{"description":"OK"},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"You must provide the request header\n\"Accept:application/octet-stream\" when calling this API.\nThe capture file can only be found in MP which receives the capture request.\n","parameters":[{"description":"Livetrace session ID","required":true,"type":"string","name":"livetrace-session-id","in":"path"}],"produces":["application/octet-stream"],"tags":["Management Plane API","Troubleshooting And Monitoring","Livetrace"],"summary":"Get reverse packet capture file proxy","x-vmw-nsx-module":"LiveTrace","consumes":["application/json"],"operationId":"GetReversePktCapFileProxy"}},"/node/file-store/{file-name}/thumbprint":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FileThumbprint"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read file thumbprint","parameters":[{"description":"Name of the file for which thumbprint should be computed","required":true,"type":"string","name":"file-name","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","File Store"],"summary":"Read file thumbprint","x-vmw-nsx-module":"FileStoreModule","consumes":["application/json"],"operationId":"ReadFileThumbprint"}},"/serviceinsertion/service-instances":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ServiceInstanceListResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns all Service-Instance(s) of all Services present in system.\nWhen request parameter (deployed_to or service_deployment_id) is provided as a part of request,\nit will filter out Service-Instances accordingly.\n","parameters":[{"description":"Deployed_to referenced by service instances present in system","required":false,"type":"string","name":"deployed_to","in":"query"},{"description":"Service Deployment Id using which the instances were deployed","required":false,"type":"string","name":"service_deployment_id","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Get all Service-Instances present in system","x-vmw-nsx-module":"ServiceInsertion","consumes":["application/json"],"operationId":"ListServiceInstances"}},"/node/services/telemetry/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read Telemetry service status","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Telemetry Service"],"summary":"Read Telemetry service status","x-vmw-nsx-module":"NodePhonehomeCoordinatorService","consumes":["application/json"],"operationId":"ReadPhonehomeCoordinatorServiceStatus"}},"/node/mode":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeMode"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns current Node Mode.\n","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Manager Configuration"],"summary":"NodeMode","x-vmw-nsx-module":"ApplianceModes","consumes":["application/json"],"operationId":"GetNodeMode"}},"/edge-clusters":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/EdgeCluster"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Creates a new edge cluster.\nIt only supports homogeneous members.\nThe TransportNodes backed by EdgeNode are only allowed in cluster members.\nDeploymentType (VIRTUAL_MACHINE|PHYSICAL_MACHINE) of these EdgeNodes is\nrecommended to be the same. EdgeCluster supports members of different\ndeployment types.\n","parameters":[{"schema":{"$ref":"#/definitions/EdgeCluster"},"required":true,"name":"EdgeCluster","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Edge Clusters","Edge Clusters"],"summary":"Create Edge Cluster","x-vmw-nsx-module":"EdgeClusters","consumes":["application/json"],"operationId":"CreateEdgeCluster"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EdgeClusterListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about the configured edge clusters, which enable you to\ngroup together transport nodes of the type EdgeNode and apply fabric\nprofiles to all members of the edge cluster. Each edge node can participate\nin only one edge cluster.\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Edge Clusters","Edge Clusters"],"summary":"List Edge Clusters","x-vmw-nsx-module":"EdgeClusters","consumes":["application/json"],"operationId":"ListEdgeClusters"}},"/firewall/sections/{section-id}/rules?action=create_multiple":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FirewallRuleList"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"description":"Bad Request"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Create multiple firewall rules in existing firewall section bounded by\nlimit of 1000 firewall rules per section. Adding multiple firewall rules in\na section modifies parent section entity and simultaneous update (modify)\noperations on same section are not allowed to prevent overwriting stale\ncontents to firewall section. If a concurrent update is performed, HTTP\nresponse code 409 will be returned to the client operating on stale data.\nThat client should retrieve the firewall section again and re-apply its\nupdate.\n","parameters":[{"required":true,"type":"string","name":"section-id","in":"path"},{"schema":{"$ref":"#/definitions/FirewallRuleList"},"required":true,"name":"FirewallRuleList","in":"body"},{"in":"query","description":"Identifier of the anchor rule or section. This is a required field in case operation like 'insert_before' and 'insert_after'.","required":false,"maxLength":64,"type":"string","name":"id"},{"enum":["insert_top","insert_bottom","insert_after","insert_before"],"description":"Operation","default":"insert_top","required":false,"in":"query","type":"string","name":"operation"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Firewall"],"summary":"Add Multiple Rules in a Section","x-vmw-nsx-module":"Firewall","consumes":["application/json"],"operationId":"AddRulesInSection"}},"/node/services/messaging-manager?action=stop":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the NSX Messaging Manager service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Messaging Manager Service"],"summary":"Restart, start or stop the NSX Messaging Manager service","x-vmw-nsx-module":"NodeNSXMessagingManagerService","consumes":["application/json"],"operationId":"CreateNSXMessagingManagerServiceActionStop"}},"/serviceinsertion/services/{service-id}/service-deployments/{service-deployment-id}?action=upgrade":{"post":{"responses":{"200":{"description":"OK"},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"If new deployment spec is provided, the deployment will be moved to the provided spec provided\nthat current deployment state is either UPGRADE_FAILED or DEPLOYMENT_SUCCESSFUL\nIf same deployment spec is provided, upgrade will be done only if current deployment state is\nUPGRADE_FAILED \n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"required":true,"type":"string","name":"service-deployment-id","in":"path"},{"schema":{"$ref":"#/definitions/DeploymentSpecName"},"required":true,"name":"DeploymentSpecName","in":"body"}],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Upgrade all VMs part of this service deployment to new Spec OVF.","x-vmw-nsx-module":"ServiceInsertionVMDeployment","consumes":["application/json"],"operationId":"UpgradeServiceDeployment"}},"/trust-management/csrs/{csr-id}?action=import":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/CertificateList"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Imports a certificate authority (CA)-signed certificate for a CSR. This\naction links the certificate to the private key created by the CSR. The\npem_encoded string in the request body is the signed certificate provided by\nyour CA in response to the CSR that you provide to them. After this\noperation you can delete the CSR.\n","parameters":[{"description":"CSR this certificate is associated with","required":true,"type":"string","name":"csr-id","in":"path"},{"schema":{"$ref":"#/definitions/TrustObjectData"},"required":true,"name":"TrustObjectData","in":"body"}],"produces":["application/json"],"tags":["System Administration","Settings","Certificates","CSR"],"summary":"Import a Certificate Associated with an Approved CSR","x-vmw-nsx-module":"CertificateManager","consumes":["application/json"],"operationId":"ImportCertificate"}},"/pktcap/session/{session-id}?action=terminate":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PacketCaptureSession"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Terminate the packet capture session by session id.\n","parameters":[{"description":"Packet capture session id","required":true,"type":"string","name":"session-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Troubleshooting And Monitoring","Packet Capture"],"summary":"Terminate the packet capture session by session id","x-vmw-nsx-module":"PacketCapture","consumes":["application/json"],"operationId":"TerminatePacketCaptureSession"}},"/cluster/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ClusterStatus"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns status information for the NSX cluster control role and management\nrole.\n","produces":["application/json"],"tags":["System Administration","Configuration","NSX Managers","Clusters","Cluster Status"],"summary":"Read Cluster Status","x-vmw-nsx-module":"ClusterManagement","consumes":["application/json"],"operationId":"ReadClusterStatus"}},"/systemhealth/appliances/latency/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ApplianceLatencyListResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Show the details of latency status in all appliances.\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["System Administration","Monitoring","System Health","Appliance","Process"],"summary":"Show the details of latency status for all appliances","x-vmw-nsx-module":"ShaApplianceMonitor","consumes":["application/json"],"operationId":"ShowAllApplianceLatencyData"}},"/configs/node/mode":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeMode"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"description":"Internal Server Error"}},"description":"Currently only a switch from \"VMC_LOCAL\" to \"VMC\" is supported.\nReturns a new Node Mode, if the request successfuly changed it.\nOptionally provisions public oauth2 client info.\n","parameters":[{"schema":{"$ref":"#/definitions/SwitchingToVmcModeParameters"},"required":true,"name":"SwitchingToVmcModeParameters","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","NSX Managers","Manager Mode"],"summary":"NodeMode","x-vmw-nsx-module":"ApplianceModes","consumes":["application/json"],"operationId":"ChangeNodeMode"}},"/logical-routers/{logical-router-id}/routing/bgp/community-lists":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BGPCommunityList"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Add a new BGP Community List on a Logical Router\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"schema":{"$ref":"#/definitions/BGPCommunityList"},"required":true,"name":"BGPCommunityList","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Routing Configuration"],"summary":"Create a new BGP community list on a logical router","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"CreateBGPCommunityList"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BGPCommunityListListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Paginated list of BGP Community Lists on a Logical Router\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Routing Configuration"],"summary":"Paginated list of BGP community lists on a logical router","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"ListBGPCommunityLists"}},"/node/services/manager?action=start":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Manager Service"],"summary":"Restart, start or stop the service","x-vmw-nsx-module":"NodeProtonService","consumes":["application/json"],"operationId":"CreateProtonServiceActionStart"}},"/node/services/cm-inventory/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read manager service status","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Cm Inventory Service"],"summary":"Read manager service status","x-vmw-nsx-module":"NodeCminventoryService","consumes":["application/json"],"operationId":"ReadCminventoryServiceStatus"}},"/node/services/telemetry":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read Telemetry service properties","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Telemetry Service"],"summary":"Read Telemetry service properties","x-vmw-nsx-module":"NodePhonehomeCoordinatorService","consumes":["application/json"],"operationId":"ReadPhonehomeCoordinatorService"}},"/node/services/ui-service/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read ui service status","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","User Interface Service"],"summary":"Read ui service status","x-vmw-nsx-module":"NodeUiServiceService","consumes":["application/json"],"operationId":"ReadNsxUiServiceServiceStatus"}},"/serviceinsertion/services/{service-id}/service-instances/{service-instance-id}/instance-runtimes?action=deploy":{"post":{"responses":{"201":{"description":"Created"},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Deploys one service VM as standalone, or two service VMs as HA where one VM is active and another one is standby.\n\nDuring the deployment of service VMs, service will be set up based on deployment events using callbacks.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"required":true,"type":"string","name":"service-instance-id","in":"path"}],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Deploy and set up service VMs either as standalone or HA","x-vmw-nsx-module":"ServiceInsertionVMDeployment","consumes":["application/json"],"operationId":"DeployServiceVMs"}},"/vpn/ipsec/ike-profiles/{ipsec-vpn-ike-profile-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IPSecVPNIKEProfile"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Edit custom IKE Profile. System owned profiles are non editable.","parameters":[{"required":true,"type":"string","name":"ipsec-vpn-ike-profile-id","in":"path"},{"schema":{"$ref":"#/definitions/IPSecVPNIKEProfile"},"required":true,"name":"IPSecVPNIKEProfile","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","VPN","IPSEC","IKE Profiles"],"summary":"Edit custom IKE Profile","x-vmw-nsx-module":"IPSecVPN","consumes":["application/json"],"operationId":"UpdateIPSecVPNIKEProfile"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IPSecVPNIKEProfile"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get custom IKE Profile, given the particular id.","parameters":[{"required":true,"type":"string","name":"ipsec-vpn-ike-profile-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","VPN","IPSEC","IKE Profiles"],"summary":"Get IKE Profile","x-vmw-nsx-module":"IPSecVPN","consumes":["application/json"],"operationId":"GetIPSecVPNIKEProfile"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete custom IKE Profile. Profile can not be deleted if profile has references to it.","parameters":[{"required":true,"type":"string","name":"ipsec-vpn-ike-profile-id","in":"path"},{"default":false,"description":"Force delete the resource even if it is being used somewhere\n","type":"boolean","name":"force","in":"query"}],"tags":["Management Plane API","Networking","VPN","IPSEC","IKE Profiles"],"summary":"Delete custom IKE Profile","x-vmw-nsx-module":"IPSecVPN","consumes":["application/json"],"operationId":"DeleteIPSecVPNIKEProfile"}},"/fabric/virtual-machines?action=remove_tags":{"post":{"responses":{"204":{"description":"No Content"},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Perform action on a specific virtual machine. External id of the virtual machine needs to be\nprovided in the request body. Some of the actions that can be performed are update tags, add\ntags, remove tags.\nTo add tags to existing list of tag, use action parameter add_tags.\nTo remove tags from existing list of tag, use action parameter remove_tags.\nTo replace existing tags with new tags, use action parameter update_tags.\nTo clear all tags, provide an empty list and action parameter as update_tags.\nThe vmw-async: True HTTP header cannot be used with this API.\n","parameters":[{"schema":{"$ref":"#/definitions/VirtualMachineTagUpdate"},"required":true,"name":"VirtualMachineTagUpdate","in":"body"}],"tags":["Policy","Inventory","Virtual Machines"],"summary":"Perform action on specified virtual machine e.g. update tags","x-vmw-nsx-module":"InventoryVmTag","consumes":["application/json"],"operationId":"RemoveVirtualMachineTags"}},"/dns/forwarders/{forwarder-id}/failed-queries":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DnsFailedQueries"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Return the given count of recent failed DNS queries from DNS forwarder.\nSince the DNS forwarder is running in Acitve/Standby HA mode on transport\nnodes, the given count of queries will be returned from each nodes. Hence\nthe total queries returned could be doubled.\nIf no count is specified, 100 recent failed queries are returned. If the\nrecent failures is less than the given count, all the failures will be\nreturned. The maximum count is 1,000.\n","parameters":[{"required":true,"type":"string","name":"forwarder-id","in":"path"},{"description":"The count of the failed DNS queries","format":"int64","default":100,"required":false,"maximum":1000,"minimum":1,"in":"query","type":"integer","name":"count"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","DNS"],"summary":"Get the recent failed DNS queries","x-vmw-nsx-module":"DnsForwarder","consumes":["application/json"],"operationId":"GetFailedDnsQueries"}},"/node/users/{userid}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeUserProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"409":{"description":"Conflict"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"description":"Service Unavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Updates attributes of an existing NSX appliance user. This method\ncannot be used to add a new user. Modifiable attributes include the\nusername, full name of the user, and password. If you specify a password in\na PUT request, it is not returned in the response. Nor is it returned in a\nGET request.\nThe specified password does not meet the following complexity requirements:\n- minimum 12 characters in length\n- minimum 1 uppercase character\n- minimum 1 lowercase character\n- minimum 1 numeric character\n- minimum 1 special character\n- minimum 5 unique characters\n- default password complexity rules as enforced by the Linux PAM module\nThe valid user IDs are: 0, 10000, 10002.\nNote that invoking this API does not update any user-related properties of\nexisting objects in the system and does not modify the username field in existing\naudit log entries.\n","parameters":[{"description":"User id of the user","required":true,"type":"string","name":"userid","in":"path"},{"schema":{"$ref":"#/definitions/NodeUserProperties"},"required":true,"name":"NodeUserProperties","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","User Management","Users"],"summary":"Update node user","x-vmw-nsx-module":"NodeUsers","consumes":["application/json"],"operationId":"UpdateNodeUser"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeUserProperties"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about a specified user who is configured to log in to the\nNSX appliance. The valid user IDs are: 0, 10000, 10002.\n","parameters":[{"description":"User id of the user","required":true,"type":"string","name":"userid","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","User Management","Users"],"summary":"Read node user","x-vmw-nsx-module":"NodeUsers","consumes":["application/json"],"operationId":"ReadNodeUser"}},"/nvds-urt/status-summary/{precheck-id}":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NvdsUpgradeStatusSummary"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get summary of N-VDS to VDS migration","parameters":[{"required":true,"type":"string","name":"precheck-id","in":"path"},{"description":"cluster identifier","required":false,"type":"string","name":"cluster_id","in":"query"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Transport Nodes"],"summary":"Get summary of N-VDS to VDS migration","x-vmw-nsx-module":"NvdsUpgradeReadinessCheck","consumes":["application/json"],"operationId":"GetNvdsUpgradeReadinessCheckSummary"}},"/loadbalancer/rules":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/LbRule"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Create a load balancer rule.\n","parameters":[{"schema":{"$ref":"#/definitions/LbRule"},"required":true,"name":"LbRule","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Create a load balancer rule","x-vmw-nsx-module":"LoadBalancer","consumes":["application/json"],"operationId":"CreateLoadBalancerRule"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LbRuleListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Retrieve a paginated list of load balancer rules.\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Retrieve a paginated list of load balancer rules","x-vmw-nsx-module":"LoadBalancer","consumes":["application/json"],"operationId":"ListLoadBalancerRules"}},"/ipfix-collector-profiles/{ipfix-collector-profile-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IpfixCollectorUpmProfile"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update an existing IPFIX collector profile with profile ID and modified\nproperties.\n","parameters":[{"required":true,"type":"string","name":"ipfix-collector-profile-id","in":"path"},{"schema":{"$ref":"#/definitions/IpfixCollectorUpmProfile"},"required":true,"name":"IpfixCollectorUpmProfile","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Troubleshooting And Monitoring","IPFIX"],"summary":"Update an existing IPFIX collector profile","x-vmw-nsx-module":"UpmIpfixCollector","consumes":["application/json"],"operationId":"UpdateIpfixCollectorUpmProfile"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IpfixCollectorUpmProfile"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get an existing IPFIX collector profile by profile ID.","parameters":[{"required":true,"type":"string","name":"ipfix-collector-profile-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Troubleshooting And Monitoring","IPFIX"],"summary":"Get an existing IPFIX collector profile","x-vmw-nsx-module":"UpmIpfixCollector","consumes":["application/json"],"operationId":"GetIpfixCollectorUpmProfile"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete an existing IPFIX collector profile by ID.","parameters":[{"required":true,"type":"string","name":"ipfix-collector-profile-id","in":"path"}],"tags":["Management Plane API","Troubleshooting And Monitoring","IPFIX"],"summary":"Delete an existing IPFIX collector profile","x-vmw-nsx-module":"UpmIpfixCollector","consumes":["application/json"],"operationId":"DeleteIpfixCollectorUpmProfile"}},"/upgrade/upgrade-unit-groups/{group-id}/upgrade-unit/{upgrade-unit-id}?action=reorder":{"post":{"responses":{"200":{"description":"OK"},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Reorder an upgrade unit within the upgrade unit group by placing it\nbefore/after the specified upgrade unit\n","parameters":[{"required":true,"type":"string","name":"group-id","in":"path"},{"required":true,"type":"string","name":"upgrade-unit-id","in":"path"},{"schema":{"$ref":"#/definitions/ReorderRequest"},"required":true,"name":"ReorderRequest","in":"body"}],"tags":["System Administration","Lifecycle Management","Upgrade","Group"],"summary":"Reorder an upgrade unit within the upgrade unit group","x-vmw-nsx-module":"Upgrade","consumes":["application/json"],"operationId":"ReorderUpgradeUnit"}},"/migration/plan?action=start":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Start the migration. Migration will start as per the migration plan.\n","tags":["System Administration","Lifecycle Management","Migration","Plan"],"summary":"Start migration","x-vmw-nsx-module":"Migration","consumes":["application/json"],"operationId":"StartMigration"}},"/systemhealth/container-cluster/{cluster-id}/ncp/status":{"get":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/ContainerClusterSummary"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get the container cluster status by given id","parameters":[{"required":true,"type":"string","name":"cluster-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Monitoring","System Health","Container"],"summary":"Get the container cluster status by given id","x-vmw-nsx-module":"TnContainerStatus","consumes":["application/json"],"operationId":"ReadContainerClusterStatus"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Create container cluster status list","parameters":[{"required":true,"type":"string","name":"cluster-id","in":"path"}],"tags":["System Administration","Monitoring","System Health","Container"],"summary":"Create container cluster status list","x-vmw-nsx-module":"TnContainerStatus","consumes":["application/json"],"operationId":"DeleteContainerClusterSummary"}},"/firewall/sections/{section-id}/rules":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FirewallRule"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"description":"Bad Request"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Adds a new firewall rule in existing firewall section. Adding firewall rule\nto a section modifies parent section entity and simultaneous update (modify)\noperations on same section are not allowed to prevent overwriting stale\ncontent to firewall section. If a concurrent update is performed, HTTP\nresponse code 409 will be returned to the client operating on stale data.\nThat client should retrieve the firewall section again and re-apply its\nupdate.\n","parameters":[{"required":true,"type":"string","name":"section-id","in":"path"},{"schema":{"$ref":"#/definitions/FirewallRule"},"required":true,"name":"FirewallRule","in":"body"},{"in":"query","description":"Identifier of the anchor rule or section. This is a required field in case operation like 'insert_before' and 'insert_after'.","required":false,"maxLength":64,"type":"string","name":"id"},{"enum":["insert_top","insert_bottom","insert_after","insert_before"],"description":"Operation","default":"insert_top","required":false,"in":"query","type":"string","name":"operation"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Firewall"],"summary":"Add a Single Rule in a Section","x-vmw-nsx-module":"Firewall","consumes":["application/json"],"operationId":"AddRuleInSection"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FirewallRuleListResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Return all firewall rule(s) information for a given firewall section.\n","parameters":[{"required":true,"type":"string","name":"section-id","in":"path"},{"description":"AppliedTo's referenced by this section or section's Distributed Service Rules .","required":false,"type":"string","name":"applied_tos","in":"query"},{"description":"Limits results to sections having rules with specific Context Profiles.","type":"string","name":"context_profiles","in":"query"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Toggle to search with direct or indirect references.","default":false,"required":false,"in":"query","type":"boolean","name":"deep_search"},{"description":"Destinations referenced by this section's Distributed Service Rules .","required":false,"type":"string","name":"destinations","in":"query"},{"description":"Limits results to sections having rules with specific Extended Sources.","type":"string","name":"extended_sources","in":"query"},{"enum":["FILTER","SEARCH"],"description":"Filter type","default":"FILTER","required":false,"in":"query","type":"string","name":"filter_type"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"description":"Return invalid references in results.","default":false,"required":false,"in":"query","type":"boolean","name":"search_invalid_references"},{"description":"NSService referenced by this section's Distributed Service Rules .","required":false,"type":"string","name":"services","in":"query"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"description":"Sources referenced by this section's Distributed Service Rules .","required":false,"type":"string","name":"sources","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Firewall"],"summary":"Get All the Rules for a Section","x-vmw-nsx-module":"Firewall","consumes":["application/json"],"operationId":"GetRules"}},"/migration/migration-units-stats":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MigrationUnitTypeStatsList"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get migration units stats","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"description":"Synchronize before returning migration unit stats","default":false,"required":false,"in":"query","type":"boolean","name":"sync"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Migration","Migration Units"],"summary":"Get migration units stats","x-vmw-nsx-module":"Migration","consumes":["application/json"],"operationId":"GetMigrationUnitsStats"}},"/transport-nodes/{transportnode-id}?action=resync_host_config":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Resync the TransportNode configuration on a host.\nIt is similar to updating the TransportNode with existing configuration,\nbut force synce these configurations to the host (no backend optimizations).\n","parameters":[{"required":true,"type":"string","name":"transportnode-id","in":"path"}],"tags":["System Administration","Configuration","Fabric","Nodes","Transport Nodes"],"summary":"Resync a Transport Node","x-vmw-nsx-module":"TransportNodeLcm","consumes":["application/json"],"operationId":"ResyncTransportNode"}},"/license":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/License"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Deprecated. Use the POST /licenses API instead\n","parameters":[{"schema":{"$ref":"#/definitions/License"},"required":true,"name":"License","in":"body"}],"produces":["application/json"],"tags":["System Administration","Settings","Licenses"],"summary":"Deprecated. Assign an Updated Enterprise License Key\n","x-vmw-nsx-module":"License","consumes":["application/json"],"operationId":"UpdateLicense"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/License"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Deprecated. Use the GET /licenses API instead.\n","produces":["application/json"],"tags":["System Administration","Settings","Licenses"],"summary":"Deprecated. Return the Enterprise License\n","x-vmw-nsx-module":"License","consumes":["application/json"],"operationId":"GetLicense"}},"/dhcp/servers/{server-id}/statistics":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DhcpStatistics"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the statistics of the given dhcp server.\n","parameters":[{"required":true,"type":"string","name":"server-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Services","DHCP"],"summary":"Get DHCP statistics with given dhcp server id","x-vmw-nsx-module":"AggSvcDhcp","consumes":["application/json"],"operationId":"GetDhcpStatistics"}},"/dhcp/relay-profiles/{relay-profile-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DhcpRelayProfile"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Modifies the specified dhcp relay profile.\n","parameters":[{"required":true,"type":"string","name":"relay-profile-id","in":"path"},{"schema":{"$ref":"#/definitions/DhcpRelayProfile"},"required":true,"name":"DhcpRelayProfile","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","DHCP Relay Profiles"],"summary":"Update a DHCP Relay Profile","x-vmw-nsx-module":"DhcpRelay","consumes":["application/json"],"operationId":"UpdateDhcpRelayProfile"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Deletes the specified dhcp relay profile.","parameters":[{"required":true,"type":"string","name":"relay-profile-id","in":"path"}],"tags":["Management Plane API","Networking","Services","DHCP Relay Profiles"],"summary":"Delete a DHCP Relay Profile","x-vmw-nsx-module":"DhcpRelay","consumes":["application/json"],"operationId":"DeleteDhcpRelayProfile"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DhcpRelayProfile"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about the specified dhcp relay profile.","parameters":[{"required":true,"type":"string","name":"relay-profile-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","DHCP Relay Profiles"],"summary":"Read a DHCP Relay Profile","x-vmw-nsx-module":"DhcpRelay","consumes":["application/json"],"operationId":"ReadDhcpRelayProfile"}},"/administration/audit-logs":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AuditLogListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"409":{"description":"Conflict"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"502":{"description":"Bad Gateway"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"This API is executed on a manager node to display audit logs from all nodes\ninside the management plane cluster. An audit log collection will be\ntriggered if the local master audit log is outdated.\n","parameters":[{"schema":{"$ref":"#/definitions/AuditLogRequest"},"required":true,"name":"AuditLogRequest","in":"body"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","format":"int64","type":"integer","name":"cursor","in":"query"},{"description":"Fields to include in query results","type":"string","name":"fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":100,"maximum":100,"minimum":0,"in":"query","type":"integer","name":"page_size"}],"produces":["application/json"],"tags":["System Administration","Monitoring","Logs","Audit Logs"],"summary":"Collect audit logs from registered manager nodes","x-vmw-nsx-module":"NodeAuditLog","consumes":["application/json"],"operationId":"CollectAuditLogs"}},"/firewall/profiles":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/BaseFirewallProfile"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Create a firewall profile with values provided. It creates profile based\nresource_type in the payload.\n","parameters":[{"schema":{"$ref":"#/definitions/BaseFirewallProfile"},"required":true,"name":"BaseFirewallProfile","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Firewall"],"summary":"Create a firewall profile.","x-vmw-nsx-module":"FirewallProfile","consumes":["application/json"],"operationId":"CreateFirewallProfile"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FirewallProfileListResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"List all the firewall profiles available by requested resource_type.\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"description":"Profile resource type","required":true,"type":"string","name":"resource_type","in":"query"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Firewall"],"summary":"Get firewall profiles available.","x-vmw-nsx-module":"FirewallProfile","consumes":["application/json"],"operationId":"ListFirewallProfiles"}},"/logical-routers/{logical-router-id}/routing/static-routes/bfd-peers/{bfd-peer-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/StaticHopBfdPeer"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Modifies the static route BFD peer.\nModifiable parameters includes peer IP, enable flag and configuration of the BFD peer.\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"required":true,"type":"string","name":"bfd-peer-id","in":"path"},{"schema":{"$ref":"#/definitions/StaticHopBfdPeer"},"required":true,"name":"StaticHopBfdPeer","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","BFD Peers"],"summary":"Update a static route BFD peer","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"UpdateStaticHopBfdPeer"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/StaticHopBfdPeer"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read the BFD peer having specified ID.\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"required":true,"type":"string","name":"bfd-peer-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","BFD Peers"],"summary":"Read a static route BFD peer","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"ReadStaticHopBfdPeer"},"delete":{"responses":{"200":{"description":"OK"},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Deletes the specified BFD peer present on specified logical router.\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"required":true,"type":"string","name":"bfd-peer-id","in":"path"},{"default":false,"description":"Force delete the resource even if it is being used somewhere\n","type":"boolean","name":"force","in":"query"}],"tags":["Management Plane API","Networking","Logical Routing And Services","BFD Peers"],"summary":"Delete a specified static route BFD peer cofigured on a specified logical router","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"DeleteStaticHopBfdPeer"}},"/logical-switches/{lswitch-id}/mac-table?format=csv":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MacAddressCsvListResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns MAC table of a specified logical switch in CSV format from the given transport\nnode if a transport node id is given in the query parameter from the\nCentral Controller Plane.\nThe query parameter \"source=cached\" is not supported.\n","parameters":[{"required":true,"type":"string","name":"lswitch-id","in":"path"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"},{"description":"TransportNode Id","required":false,"type":"string","name":"transport_node_id","in":"query"}],"produces":["text/csv"],"tags":["Management Plane API","Networking","Logical Switching","Logical Switches"],"summary":"Get MAC Table for Logical Switch of the Given ID (lswitch-id)","x-vmw-nsx-module":"AggSvcLogicalSwitch","consumes":["application/json"],"operationId":"GetLogicalSwitchMacTableInCsvFormat"}},"/node/services/cluster_manager":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read cluster boot manager service properties","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Cluster Manager Service"],"summary":"Read cluster boot manager service properties","x-vmw-nsx-module":"NodeClusterBootManagerService","consumes":["application/json"],"operationId":"ReadClusterBootManagerService"}},"/node/users/{userid}?action=reset_password":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"409":{"description":"Conflict"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"description":"Service Unavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Unlike the PUT version of this call (PUT /node/users/<userid>), this API\ndoes not require that the current password for the user be provided. The\naccount of the target user must be \"ACTIVE\" for the call to succeed.\nThis API only supports user IDs 10002, 10003, and 10004.\n","parameters":[{"description":"User id of the user","required":true,"type":"string","name":"userid","in":"path"},{"schema":{"$ref":"#/definitions/NodeUserPasswordProperty"},"required":true,"name":"NodeUserPasswordProperty","in":"body"}],"tags":["System Administration","Configuration","Fabric","Nodes","User Management","Users"],"summary":"Reset a user's password without requiring their current password","x-vmw-nsx-module":"NodeUsersManagerNodeType","consumes":["application/json"],"operationId":"ResetNodeUserPasswordResetPassword"}},"/trust-management/crl-distribution-points":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/CrlDistributionPoint"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Create an entity that will represent a Crl Distribution Point\n","parameters":[{"schema":{"$ref":"#/definitions/CrlDistributionPoint"},"required":true,"name":"CrlDistributionPoint","in":"body"}],"produces":["application/json"],"tags":["System Administration","Settings","Certificates","CRL"],"summary":"Create a Crl Distribution Point","x-vmw-nsx-module":"CertificateManager","consumes":["application/json"],"operationId":"CreateCrlDistributionPoint"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/CrlDistributionPointList"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Return the list of CrlDistributionPoints","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["System Administration","Settings","Certificates","CRL"],"summary":"Return the list of CrlDistributionPoints","x-vmw-nsx-module":"CertificateManager","consumes":["application/json"],"operationId":"ListCrlDistributionPoints"}},"/ns-groups/{ns-group-id}/effective-transport-node-members":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EffectiveMemberResourceListResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns effective transport node members of the specified NSGroup.\nThis API is applicable only for NSGroups containing TransportNode member type.\nFor NSGroups containing other member types,it returns an empty list.\n","parameters":[{"description":"NSGroup Id","required":true,"type":"string","name":"ns-group-id","in":"path"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Grouping Objects","NS Groups"],"summary":"Get effective transport node members translated from the NSGroup","x-vmw-nsx-module":"NSGroup","consumes":["application/json"],"operationId":"GetEffectiveTransportNodeMembers"}},"/vpn/ipsec/sessions/{session-id}/statistics":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IPSecVPNSessionStatistics"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get statistics of a vpn session across all tunnels and IKE session. Query parameter \"source=realtime\" is the only supported source.","parameters":[{"required":true,"type":"string","name":"session-id","in":"path"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"}],"produces":["application/json"],"tags":["Management Plane API","Networking","VPN","Statistics","IPSEC Sessions Statistics"],"summary":"Get IPSec VPN session statistics","x-vmw-nsx-module":"VPNStatistics","consumes":["application/json"],"operationId":"GetIPSecVPNSessionStatistics"}},"/logical-routers/{logical-router-id}?action=reprocess":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Reprocess logical router configuration and configuration of related entities like logical router ports, static routing, etc.\nAny missing Updates are published to controller.\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"}],"tags":["Management Plane API","Networking","Logical Routing And Services","Logical Routers"],"summary":"Reprocesses a logical router configuration and publish updates to controller","x-vmw-nsx-module":"LogicalRouter","consumes":["application/json"],"operationId":"ReProcessLogicalRouter"}},"/upgrade/upgrade-unit-groups-status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UpgradeUnitGroupStatusListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get upgrade status for upgrade unit groups","parameters":[{"description":"Component type on which the action is performed or on which the results are filtered","required":false,"type":"string","name":"component_type","in":"query"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Upgrade","Group"],"summary":"Get upgrade status for upgrade unit groups","x-vmw-nsx-module":"Upgrade","consumes":["application/json"],"operationId":"GetUpgradeUnitGroupsStatus"}},"/upgrade/uc-upgrade-status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UcUpgradeStatus"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get upgrade-coordinator upgrade status\n","produces":["application/json"],"tags":["System Administration","Lifecycle Management","Upgrade","Status"],"summary":"Get upgrade-coordinator upgrade status","x-vmw-nsx-module":"Upgrade","consumes":["application/json"],"operationId":"GetUcUpgradeStatus"}},"/node/users/{userid}?action=activate":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeUserProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"409":{"description":"Conflict"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"description":"Service Unavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Activates the account for this user. When an account is successfully\nactivated, the \"status\" field in the response is \"ACTIVE\".\nThis API is not supported for userid 0 and userid 10000.\n","parameters":[{"description":"User id of the user","required":true,"type":"string","name":"userid","in":"path"},{"schema":{"$ref":"#/definitions/NodeUserPasswordProperty"},"required":true,"name":"NodeUserPasswordProperty","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","User Management","Users"],"summary":"Activate a user account with a password","x-vmw-nsx-module":"NodeUsersManagerNodeType","consumes":["application/json"],"operationId":"ActivateNodeUserActivate"}},"/node/services/idps-reporting?action=restart":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the idps-reporting service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Idps Reporting Service"],"summary":"Restart, start or stop the idps-reporting service","x-vmw-nsx-module":"IdpsReportingService","consumes":["application/json"],"operationId":"CreateIdpsReportingServiceActionRestart"}},"/node/services/nsx-message-bus/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read NSX Message Bus service status","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","NSX Message Service"],"summary":"Read NSX Message Bus service status","x-vmw-nsx-module":"NodeNSXMessageBusService","consumes":["application/json"],"operationId":"ReadNSXMessageBusServiceStatus"}},"/node/core-dumps/{file-name}?action=copy_to_remote_file":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"504":{"description":"Gateway Timeout"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Copy system generated core dump file to a remote server. If you use scp or\nsftp, you must provide the remote server's SSH fingerprint. See the\nNSX-T Administration Guide for information and instructions\nabout finding the SSH fingerprint.\n","parameters":[{"description":"Destination filename","required":true,"type":"string","name":"file-name","in":"path"},{"schema":{"$ref":"#/definitions/CopyToRemoteFileProperties"},"required":true,"name":"CopyToRemoteFileProperties","in":"body"}],"tags":["System Administration","Monitoring","Logs","Core Dumps"],"summary":"Copy system generated core dump file to a remote file store","x-vmw-nsx-module":"CoreDumpModule","consumes":["application/json"],"operationId":"CopyCoreDumpToRemoteFileCopyToRemoteFile"}},"/node/services/nsx-message-bus?action=start":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the NSX Message Bus service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","NSX Message Service"],"summary":"Restart, start or stop the NSX Message Bus service","x-vmw-nsx-module":"NodeNSXMessageBusService","consumes":["application/json"],"operationId":"CreateNSXMessageBusServiceActionStart"}},"/migration/setup?action=setEsgToRouterMappingOption":{"put":{"responses":{"200":{"description":"OK"},"401":{"description":"Unauthorized"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Set the NSX-V ESG to NSX-T Router mapping option.\n","parameters":[{"enum":["UI","FILE_UPLOAD","NO_MAPPING"],"description":"Mapping option","required":true,"in":"query","type":"string","name":"mapping_option"}],"tags":["System Administration","Lifecycle Management","Migration","Setup"],"summary":"Set the NSX-V ESG to NSX-T Router mapping option.","x-vmw-nsx-module":"Migration","consumes":["application/json"],"operationId":"SetEsgToRouterMappingOption"}},"/realization-state-barrier/current":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/CurrentRealizationStateBarrier"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the current global realization barrier number for NSX.\nThis method has been deprecated. To track realization state, use\nX-NSX-REQUESTID request header instead.\n","produces":["application/json"],"tags":["System Administration","Configuration","System Properties","Realization State Barrier"],"summary":"Gets the current barrier number","x-vmw-nsx-module":"RealizationStateBarrier","consumes":["application/json"],"operationId":"GetCurrentBarrier"}},"/cluster/nodes/deployments/{node-id}?action=delete":{"post":{"responses":{"202":{"description":"Accepted"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"description":"Bad Request"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Attempts to unregister and undeploy a specified auto-deployed cluster\nnode VM. If it is a member of a cluster, then the VM will be automatically\ndetached from the cluster before being unregistered and undeployed.\nAlternatively, if the original deployment attempt failed or the VM is\nnot found, cleans up the deployment information associated with the\ndeployment attempt.\nNote: If a VM has been successfully auto-deployed, then the associated\ndeployment information will not be deleted unless and until the VM is\nsuccessfully deleted.\n","parameters":[{"required":true,"type":"string","name":"node-id","in":"path"},{"description":"Delete by force","type":"boolean","name":"force_delete","in":"query"}],"tags":["System Administration","Configuration","NSX Managers","Clusters","Cluster Node Deployments"],"summary":"Attempt to delete an auto-deployed cluster node VM","x-vmw-nsx-module":"ClusterNodeVMDeployment","consumes":["application/json"],"operationId":"DeleteAutoDeployedClusterNodeVM"}},"/cluster-profiles/{cluster-profile-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ClusterProfile"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Modifie a specified cluster profile. The body of the PUT request must\ninclude the resource_type.\n","parameters":[{"required":true,"type":"string","name":"cluster-profile-id","in":"path"},{"schema":{"$ref":"#/definitions/ClusterProfile"},"required":true,"name":"ClusterProfile","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Profiles","Cluster Profiles"],"summary":"Update a cluster profile","x-vmw-nsx-module":"ClusterProfile","consumes":["application/json"],"operationId":"UpdateClusterProfile"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete a specified cluster profile.","parameters":[{"required":true,"type":"string","name":"cluster-profile-id","in":"path"}],"tags":["System Administration","Configuration","Fabric","Profiles","Cluster Profiles"],"summary":"Delete a cluster profile","x-vmw-nsx-module":"ClusterProfile","consumes":["application/json"],"operationId":"DeleteClusterProfile"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ClusterProfile"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about a specified cluster profile.","parameters":[{"required":true,"type":"string","name":"cluster-profile-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Profiles","Cluster Profiles"],"summary":"Get cluster profile by Id","x-vmw-nsx-module":"ClusterProfile","consumes":["application/json"],"operationId":"GetClusterProfile"}},"/logical-routers/{logical-router-id}/debug-info?format=text":{"get":{"responses":{"200":{"description":"OK","schema":{"type":"string"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"description":"Bad Request"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"API to download below information as text which will be used\nfor debugging and troubleshooting.\n1) Logical router sub-components and ports.\n2) Routing configuration as sent to central control plane.\n3) TIER1 advertised network information.\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"}],"produces":["text/plain; charset=utf-8"],"tags":["Management Plane API","Networking","Logical Routing And Services","Routing Configuration"],"summary":"Read the debug information for the logical router","x-vmw-nsx-module":"LogicalRouter","consumes":["application/json"],"operationId":"ReadDebugInfo"}},"/node/services/search?action=start":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the NSX Search service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Search Service"],"summary":"Restart, start or stop the NSX Search service","x-vmw-nsx-module":"NodeSearchService","consumes":["application/json"],"operationId":"CreateSearchServiceActionStart"}},"/logical-routers/{logical-router-id}/routing/bgp/neighbors/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BgpNeighborsStatusListResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the status of all the BGP neighbors for the Logical Router of the given id. To get BGP neighbors status for the logical router from particular node, parameter \"transport_node_id=<transportnode_id>\" needs to be specified. Query parameter \"source=realtime\" is the only supported source.","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"},{"description":"Transport node id","required":false,"type":"string","name":"transport_node_id","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Logical Routers"],"summary":"Get the status of all the BGP neighbors for the Logical Router of the given id","x-vmw-nsx-module":"AggSvcLogicalRouter","consumes":["application/json"],"operationId":"GetBgpNeighborsStatus"}},"/transport-nodes/{node-id}/tunnels":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TunnelList"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"List of tunnels","parameters":[{"description":"ID of transport node","required":true,"type":"string","name":"node-id","in":"path"},{"description":"BFD diagnostic code of Tunnel as defined in RFC 5880","enum":["0","NO_DIAGNOSTIC","1","CONTROL_DETECTION_TIME_EXPIRED","2","ECHO_FUNCTION_FAILED","3","NEIGHBOR_SIGNALED_SESSION_DOWN","4","FORWARDING_PLANE_RESET","5","PATH_DOWN","6","CONCATENATED_PATH_DOWN","7","ADMINISTRATIVELY_DOWN","8","REVERSE_CONCATENATED_PATH_DOWN"],"type":"string","name":"bfd_diagnostic_code","in":"query"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"string","name":"remote_node_id","in":"query"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"},{"description":"Tunnel status","enum":["UP","DOWN"],"type":"string","name":"status","in":"query"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Transport Node Tunnels"],"summary":"List of tunnels","x-vmw-nsx-module":"Tunnel","consumes":["application/json"],"operationId":"QueryTunnels"}},"/upgrade/upgrade-unit-groups/aggregate-info":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UpgradeUnitGroupAggregateInfoListResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Return information of all upgrade unit groups in the\nupgrade plan. If request parameter summary is set to true, then\nonly count of upgrade units will be returned, upgrade units list\nwill be empty. If request parameter component type is specified,\nthen all upgrade unit groups for that component will be returned.\n","parameters":[{"description":"Component type based on which upgrade unit groups to be filtered","required":false,"type":"string","name":"component_type","in":"query"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"description":"Flag indicating whether to return summary","default":false,"required":false,"in":"query","type":"boolean","name":"summary"},{"description":"Synchronize before returning upgrade unit groups","default":false,"required":false,"in":"query","type":"boolean","name":"sync"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Upgrade","Group"],"summary":"Return aggregate information of all upgrade unit groups","x-vmw-nsx-module":"Upgrade","consumes":["application/json"],"operationId":"GetUpgradeUnitGroupAggregateInfo"}},"/logical-routers/{logical-router-id}/routing/bgp/neighbors/{neighbor-id}/routes?format=csv":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BgpNeighborRouteDetailsInCsvFormat"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns routes learned by BGP neighbor from all edge transport nodes on\nwhich this neighbor is currently enabled in CSV format.\nIt always returns realtime response.\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"required":true,"type":"string","name":"neighbor-id","in":"path"}],"produces":["text/csv"],"tags":["Management Plane API","Networking","Logical Routing And Services","Logical Routers"],"summary":"Get BGP neighbor learned routes in CSV format\n","x-vmw-nsx-module":"AggSvcLogicalRouter","consumes":["application/json"],"operationId":"GetBgpNeighborRoutesInCsvFormat"}},"/pools/ip-subnets":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/IpBlockSubnet"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"409":{"description":"Conflict"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Carves out a subnet of requested size from the specified IP block. The \"size\"\nparameter and the \"block_id \" are the requireds field while invoking this API.\nIf the IP block has sufficient resources/space to allocate a subnet of specified size,\nthe response will contain all the details of the newly created subnet including the\ndisplay_name, description, cidr & allocation_ranges. Returns a conflict error\nif the IP block does not have enough resources/space to allocate a subnet of\nthe requested size.\n","parameters":[{"schema":{"$ref":"#/definitions/IpBlockSubnet"},"required":true,"name":"IpBlockSubnet","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Pool Management","IP Blocks"],"summary":"Create subnet of specified size within an IP block","x-vmw-nsx-module":"Ipam","consumes":["application/json"],"operationId":"CreateIpBlockSubnet"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IpBlockSubnetListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about all subnets present within an IP address\nblock. Information includes subnet's id, display_name, description, cidr and\nallocation ranges.\n","parameters":[{"required":false,"type":"string","name":"block_id","in":"query"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Pool Management","IP Blocks"],"summary":"List subnets within an IP block","x-vmw-nsx-module":"Ipam","consumes":["application/json"],"operationId":"ListIpBlockSubnets"}},"/logical-routers/{logical-router-id}/routing/redistribution/rules":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RedistributionRuleList"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Modifies all route redistribution rules for the specified TIER0 logical\nrouter. Set the rules list to empty to delete/clear all rules.\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"schema":{"$ref":"#/definitions/RedistributionRuleList"},"required":true,"name":"RedistributionRuleList","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Routing Configuration"],"summary":"Update All the Redistribution Rules on a Logical Router","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"UpdateRedistributionRuleList"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RedistributionRuleList"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns all the route redistribution rules for the specified\nlogical router.\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Routing Configuration"],"summary":"Read All the Redistribution Rules on a Logical Router","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"ReadRedistributionRuleList"}},"/trust-management/certificates/{cert-id}?action=validate":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/CertificateCheckingStatus"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Checks whether certificate is valid. When the certificate contains a chain, the full chain is validated.\nThe usage parameter can be SERVER (default) or CLIENT. This indicates whether the certificate needs to\nbe validated as a server-auth or a client-auth certificate.\n","parameters":[{"description":"ID of certificate to validate","required":true,"type":"string","name":"cert-id","in":"path"},{"enum":["SERVER","CLIENT"],"description":"Usage Type of the Certificate, SERVER or CLIENT. Default is SERVER","required":false,"in":"query","type":"string","name":"usage"}],"produces":["application/json"],"summary":"Validate a certificate","x-vmw-nsx-module":"CertificateManager","consumes":["application/json"],"operationId":"ValidateCertificate"}},"/cluster/nodes/{node-id}/network/interfaces/{interface-id}/stats":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeInterfaceStatisticsProperties"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"On the specified interface, returns the number of received (rx), transmitted\n(tx), and dropped packets; the number of bytes and errors received and\ntransmitted on the interface; and the number of detected collisions.\n","parameters":[{"required":true,"type":"string","name":"node-id","in":"path"},{"required":true,"type":"string","name":"interface-id","in":"path"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Manager Network Interfaces"],"summary":"Read the NSX Manager/Controller's Network Interface Statistics","x-vmw-nsx-module":"ApplianceStats","consumes":["application/json"],"operationId":"ReadClusterNodeInterfaceStatistics"}},"/firewall/excludelist?action=remove_member":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResourceReference"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Remove an existing object from the exclude list.","parameters":[{"description":"Check all parents","default":false,"required":false,"in":"query","type":"boolean","name":"deep_check"},{"in":"query","description":"identifier of the object","required":true,"maxLength":64,"type":"string","name":"object_id"},{"enum":["NSGroup","LogicalPort","LogicalSwitch"],"description":"Object type of an entity","required":false,"in":"query","type":"string","name":"object_type"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Firewall"],"summary":"Remove an existing object from the exclude list.","x-vmw-nsx-module":"ExcludeList","consumes":["application/json"],"operationId":"RemoveMember"}},"/administration/support-bundles?action=delete_async_response":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"409":{"description":"Conflict"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete existing support bundles waiting to be downloaded.","tags":["System Administration","Settings","Support Bundle"],"summary":"Delete existing support bundles waiting to be downloaded","x-vmw-nsx-module":"NodeSupportBundle","consumes":["application/json"],"operationId":"DeleteSupportBundlesAsyncResponseDeleteAsyncResponse"}},"/sites/self":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LocalSiteConfiguration"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"description":"Service Unavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get the local site configuration","produces":["application/json"],"tags":["System Administration","Configuration","Site Management"],"summary":"Get the local site configuration","x-vmw-nsx-module":"SiteManagerModule","consumes":["application/json"],"operationId":"GetSiteSelf"}},"/node/services/ntp/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read NTP service status","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","NTP"],"summary":"Read NTP service status","x-vmw-nsx-module":"NodeNTPService","consumes":["application/json"],"operationId":"ReadNTPServiceStatus"}},"/logical-switches/{lswitch-id}/state":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LogicalSwitchState"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns current state of the logical switch configuration and details of only\nout-of-sync transport nodes. This api is now deprecated. Please use new api -\npolicy/api/v1/infra/realized-state/realized-entities?intent_path={{intent-path}}\n","parameters":[{"required":true,"type":"string","name":"lswitch-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Switching","Logical Switches"],"summary":"Get the realized state associated with provided logical switch id","x-vmw-nsx-module":"LogicalSwitch","consumes":["application/json"],"operationId":"GetLogicalSwitchState"}},"/serviceinsertion/services/{service-id}/service-instances/{service-instance-id}/instance-runtimes?action=delete":{"post":{"responses":{"202":{"description":"Accepted"},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Undeploy one service VM as standalone or two service VMs as HA. Associated deployment information and instance\nruntime will also be deleted once service VMs have been un-deployed successfully.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"required":true,"type":"string","name":"service-instance-id","in":"path"}],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Remove service VMs either as standalone or HA","x-vmw-nsx-module":"ServiceInsertionVMDeployment","consumes":["application/json"],"operationId":"DeleteServiceVMs"}},"/node/logs/{log-name}/data":{"get":{"responses":{"200":{"description":"OK"},"206":{"description":"Partial Content"},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"For a single specified log file, returns the content of the log file.\nThis method supports byte-range requests. To request just a portion of a\nlog file, supply an HTTP Range header, e.g. \"Range: bytes=<start>-<end>\".\n<end> is optional, and, if omitted, the file contents from start to the\nend of the file are returned.'\n","parameters":[{"description":"Name of log to read","required":true,"type":"string","name":"log-name","in":"path"}],"produces":["application/octet-stream"],"tags":["System Administration","Configuration","Fabric","Nodes","Logs"],"summary":"Read node log contents","x-vmw-nsx-module":"NodeLogs","consumes":["application/json"],"operationId":"ReadNodeLogData"}},"/vpn/l2vpn/services":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/L2VpnService"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Create L2VPN service for a given logical router","parameters":[{"schema":{"$ref":"#/definitions/L2VpnService"},"required":true,"name":"L2VpnService","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","VPN","L2VPN","Services"],"summary":"Create L2VPN service","x-vmw-nsx-module":"L2VPN","consumes":["application/json"],"operationId":"CreateL2VpnService"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/L2VpnServiceListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get paginated list of all L2VPN services","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","VPN","L2VPN","Services"],"summary":"Get all L2VPN services","x-vmw-nsx-module":"L2VPN","consumes":["application/json"],"operationId":"ListL2VpnServices"}},"/node/services/http/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read http service status","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","HTTP Service"],"summary":"Read http service status","x-vmw-nsx-module":"NodeProxyService","consumes":["application/json"],"operationId":"ReadProxyServiceStatus"}},"/node/services/telemetry?action=start":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop Telemetry service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Telemetry Service"],"summary":"Restart, start or stop Telemetry service","x-vmw-nsx-module":"NodePhonehomeCoordinatorService","consumes":["application/json"],"operationId":"CreatePhonehomeCoordinatorServiceActionStart"}},"/sites/compatibility/remote":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RemoteSiteCompatibilityInfo"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"description":"Service Unavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the version of this site and list of compatible versions for both local and remote site,\nalso a boolean indicating whether the two are compatible, this value is true if one of the site\nversion is in the compatibility list of the other site\n","parameters":[{"schema":{"$ref":"#/definitions/RemoteSiteCredential"},"required":true,"name":"RemoteSiteCredential","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Site Management"],"summary":"Check whether the remote site version is compatible to this site","x-vmw-nsx-module":"SiteManagerModule","consumes":["application/json"],"operationId":"CompatibleListRemote"}},"/configs/inventory":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/InventoryConfig"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Supports retrieving following configuration of inventory module\n1. Soft limit on number of compute managers that can be registered.\n","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Compute Managers"],"summary":"Return inventory configuration","x-vmw-nsx-module":"Inventory","consumes":["application/json"],"operationId":"GetInventoryConfig"}},"/dhcp/relay-profiles":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/DhcpRelayProfile"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Creates a dhcp relay profile.\n","parameters":[{"schema":{"$ref":"#/definitions/DhcpRelayProfile"},"required":true,"name":"DhcpRelayProfile","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","DHCP Relay Profiles"],"summary":"Create a DHCP Relay Profile","x-vmw-nsx-module":"DhcpRelay","consumes":["application/json"],"operationId":"CreateDhcpRelayProfile"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DhcpRelayProfileListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about all dhcp relay profiles.\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","DHCP Relay Profiles"],"summary":"List All DHCP Relay Profiles","x-vmw-nsx-module":"DhcpRelay","consumes":["application/json"],"operationId":"ListDhcpRelayProfiles"}},"/upgrade/upgrade-units/{upgrade-unit-id}":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UpgradeUnit"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get a specific upgrade unit","parameters":[{"required":true,"type":"string","name":"upgrade-unit-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Upgrade","Upgrade Units"],"summary":"Get a specific upgrade unit","x-vmw-nsx-module":"Upgrade","consumes":["application/json"],"operationId":"GetUpgradeUnit"}},"/upgrade/upgrade-unit-groups/{group-id}?action=reorder":{"post":{"responses":{"200":{"description":"OK"},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Reorder an upgrade unit group by placing it before/after\nthe specified upgrade unit group.\n","parameters":[{"required":true,"type":"string","name":"group-id","in":"path"},{"schema":{"$ref":"#/definitions/ReorderRequest"},"required":true,"name":"ReorderRequest","in":"body"}],"tags":["System Administration","Lifecycle Management","Upgrade","Group"],"summary":"Reorder upgrade unit group","x-vmw-nsx-module":"Upgrade","consumes":["application/json"],"operationId":"ReorderUpgradeUnitGroup"}},"/aaa/roles/{role}?action=clone":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NewRole"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"The role with id <role> is cloned and the new id, name and description are\nthe ones provided in the request body.\n","parameters":[{"description":"Role id","required":true,"type":"string","name":"role","in":"path"},{"schema":{"$ref":"#/definitions/NewRole"},"required":true,"name":"NewRole","in":"body"}],"produces":["application/json"],"tags":["System Administration","Settings","User Management","Roles"],"summary":"Clone an already present role","x-vmw-nsx-module":"AAA","consumes":["application/json"],"operationId":"CloneRole"}},"/transport-nodes/{transport-node-id}/network/interfaces/{interface-id}":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeInterfaceProperties"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns detailed information about the specified interface. Interface\ninformation includes MTU, broadcast and host IP addresses, link and admin\nstatus, MAC address, network mask, and the IP configuration method (static\nor DHCP).\n","parameters":[{"required":true,"type":"string","name":"transport-node-id","in":"path"},{"required":true,"type":"string","name":"interface-id","in":"path"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Transport Node Interfaces"],"summary":"Read the transport node's network interface","x-vmw-nsx-module":"ApplianceStats","consumes":["application/json"],"operationId":"ReadTransportNodeInterface"}},"/lldp/transport-nodes/{node-id}/interfaces/{interface-name}":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/InterfaceNeighborProperties"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read LLDP Neighbor Properties for a specific interface of Transport Node\n","parameters":[{"description":"ID of transport node","required":true,"type":"string","name":"node-id","in":"path"},{"description":"Interface name to read","required":true,"type":"string","name":"interface-name","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","LLDP"],"summary":"Read LLDP Neighbor Properties of Transport Node by Interface Name\n","x-vmw-nsx-module":"Lldp","consumes":["application/json"],"operationId":"ReadNeighborProperties"}},"/transport-nodes/{edge-node-id}/inter-site/bgp/summary":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/InterSiteBgpSummary"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns BGP summary for all configured neighbors in tunnel VRF\non the given egde node. It always returns realtime response.\n","parameters":[{"required":true,"type":"string","name":"edge-node-id","in":"path"}],"produces":["application/json"],"tags":["Federation","Inter-Sites"],"summary":"Get inter-site BGP summary of edge node","x-vmw-nsx-module":"AggSvcInterSite","consumes":["application/json"],"operationId":"GetInterSiteEdgeNodeBgpSummary"}},"/node/services/nsx-platform-client/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read NSX Platform Client service status","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","NSX Platform Client"],"summary":"Read NSX Platform Client service status","x-vmw-nsx-module":"NodePlatformClientService","consumes":["application/json"],"operationId":"ReadPlatformClientServiceStatus"}},"/node/services/node-stats?action=start":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the NSX node-stats service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Node Stats Service"],"summary":"Restart, start or stop the NSX node-stats service","x-vmw-nsx-module":"NodeNodeStatsService","consumes":["application/json"],"operationId":"CreateNodeStatsServiceActionStart"}},"/loadbalancer/virtual-servers/{virtual-server-id}?action=update_with_rules":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LbVirtualServerWithRule"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"It is used to update virtual servers, the associated rules and update the\nbinding of virtual server and rules.\nTo add new rules, make sure the rules which have no identifier specified,\nthe new rules are automatically generated and associated to the virtual\nserver.\nTo delete old rules, the rules should not be configured in new action, the\nUUID of deleted rules should be also removed from rule_ids.\nTo update rules, the rules should be specified with new change and\nconfigured with identifier.\nIf there are some rules which are not modified, those rule should not be\nspecified in the rules list, the UUID list of rules should be specified in\nrule_ids of LbVirtualServer.\n","parameters":[{"required":true,"type":"string","name":"virtual-server-id","in":"path"},{"schema":{"$ref":"#/definitions/LbVirtualServerWithRule"},"required":true,"name":"LbVirtualServerWithRule","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Update a load balancer virtual server with rules","x-vmw-nsx-module":"LoadBalancer","consumes":["application/json"],"operationId":"UpdateLoadBalancerVirtualServerWithRules"}},"/transport-nodes/{transport-node-id}?action=restore_cluster_config":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"A host can be overridden to have different configuration than Transport\nNode Profile(TNP) on cluster. This action will restore such overridden host\nback to cluster level TNP.\n\nThis API can be used in other case. When TNP is applied to a cluster,\nif any validation fails (e.g. VMs running on host) then existing transport\nnode (TN) is not updated. In that case after the issue is resolved manually\n(e.g. VMs powered off), you can call this API to update TN as per cluster\nlevel TNP.\nThis api is now deprecated. Please use new api -\n/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/host-transport-nodes/<host-transport-node-id>?action=restore_cluster_config\n","parameters":[{"required":true,"type":"string","name":"transport-node-id","in":"path"}],"tags":["System Administration","Configuration","Fabric","Nodes","Transport Nodes"],"summary":"Apply cluster level Transport Node Profile on overridden host","x-vmw-nsx-module":"TransportNodeLcm","consumes":["application/json"],"operationId":"RestoreParentClusterConfiguration"}},"/loadbalancer/persistence-profiles":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/LbPersistenceProfile"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Create a load balancer persistence profile.\n","parameters":[{"schema":{"$ref":"#/definitions/LbPersistenceProfile"},"required":true,"name":"LbPersistenceProfile","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Create a load balancer persistence profile","x-vmw-nsx-module":"LoadBalancer","consumes":["application/json"],"operationId":"CreateLoadBalancerPersistenceProfile"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LbPersistenceProfileListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Retrieve a paginated list of load balancer persistence profiles.\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"enum":["LbCookiePersistenceProfile","LbSourceIpPersistenceProfile","LbGenericPersistenceProfile"],"description":"persistence profile type","required":false,"in":"query","type":"string","name":"type"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Retrieve a paginated list of load balancer persistence profiles","x-vmw-nsx-module":"LoadBalancer","consumes":["application/json"],"operationId":"ListLoadBalancerPersistenceProfiles"}},"/directory/ldap-server":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DirectoryLdapServerStatus"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"This API tests a LDAP server connectivity before the actual domain or LDAP server is configured. If the connectivity is good, the response will be HTTP status 200. Otherwise the response will be HTTP status 500 and corresponding error message will be returned.","parameters":[{"schema":{"$ref":"#/definitions/DirectoryLdapServer"},"required":true,"name":"DirectoryLdapServer","in":"body"},{"enum":["CONNECTIVITY"],"description":"LDAP server test requested","required":true,"in":"query","type":"string","name":"action"}],"produces":["application/json"],"tags":["System Administration","Configuration","Directory Service","LDAP Servers"],"summary":"Test a directory domain LDAP server connectivity","x-vmw-nsx-module":"DirectoryService","consumes":["application/json"],"operationId":"VerifyDirectoryLdapServer"}},"/cluster/restore/instruction-resources":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ActionableResourceListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"For restore operations requiring user input e.g. performing an action,\naccepting/rejecting an action, etc. the information to be conveyed to users\nis provided in this call.\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Id of the instruction set whose instructions are to be returned","required":true,"type":"string","name":"instruction_id","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Backup Restore Management","Restore"],"summary":"List resources for a given instruction, to be\nshown to/executed by users.\n","x-vmw-nsx-module":"ClusterRestore","consumes":["application/json"],"operationId":"ListRestoreInstructionResources"}},"/systemhealth/profiles/{profile-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SystemHealthAgentProfile"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update a system health profile definition.\n","parameters":[{"required":true,"type":"string","name":"profile-id","in":"path"},{"schema":{"$ref":"#/definitions/SystemHealthAgentProfile"},"required":true,"name":"SystemHealthAgentProfile","in":"body"}],"produces":["application/json"],"tags":["System Administration","Monitoring","System Health","Profiles"],"summary":"Update a system health profile","x-vmw-nsx-module":"SystemHealthAgent","consumes":["application/json"],"operationId":"UpdateSystemHealthAgentProfile"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SystemHealthAgentProfile"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Show the details of a system health profile.\n","parameters":[{"required":true,"type":"string","name":"profile-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Monitoring","System Health","Profiles"],"summary":"Show the details of a system health profile","x-vmw-nsx-module":"SystemHealthAgent","consumes":["application/json"],"operationId":"ShowSystemHealthAgentProfile"},"delete":{"responses":{"200":{"description":"OK"},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete an existing system health profile by ID.","parameters":[{"required":true,"type":"string","name":"profile-id","in":"path"}],"tags":["System Administration","Monitoring","System Health","Profiles"],"summary":"Delete an existing system health profile","x-vmw-nsx-module":"SystemHealthAgent","consumes":["application/json"],"operationId":"DeleteSystemHealthAgentProfile"}},"/vpn/l2vpn/sessions/{l2vpn-session-id}/peer-codes":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/L2VpnSessionPeerCodes"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get peer codes for the L2VPN session to program the remote side of the tunnel.","parameters":[{"required":true,"type":"string","name":"l2vpn-session-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","VPN","L2VPN","Sessions"],"summary":"Get peer codes for the L2VpnSession","x-vmw-nsx-module":"L2VPN","consumes":["application/json"],"operationId":"GetL2VpnSessionPeerCodes"}},"/transport-nodes/{node-id}/pnic-bond-status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PnicBondStatusListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get high-level summary of a transport node","parameters":[{"description":"ID of transport node","required":true,"type":"string","name":"node-id","in":"path"},{"description":"pNic/bond status","enum":["UNKNOWN","UP","DOWN","DEGRADED"],"type":"string","name":"status","in":"query"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Transport Node Status"],"summary":"Get high-level summary of a transport node","x-vmw-nsx-module":"Heatmap","consumes":["application/json"],"operationId":"GetPnicStatusesForTransportNode"}},"/loadbalancer/server-ssl-profiles/{server-ssl-profile-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LbServerSslProfile"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update a load balancer server-ssl profile.\n","parameters":[{"required":true,"type":"string","name":"server-ssl-profile-id","in":"path"},{"schema":{"$ref":"#/definitions/LbServerSslProfile"},"required":true,"name":"LbServerSslProfile","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Update a load balancer server-ssl profile","x-vmw-nsx-module":"LoadBalancer","consumes":["application/json"],"operationId":"UpdateLoadBalancerServerSslProfile"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete a load balancer server-ssl profile.\n","parameters":[{"required":true,"type":"string","name":"server-ssl-profile-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Delete a load balancer server-ssl profile","x-vmw-nsx-module":"LoadBalancer","consumes":["application/json"],"operationId":"DeleteLoadBalancerServerSslProfile"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LbServerSslProfile"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Retrieve a load balancer server-ssl profile.\n","parameters":[{"required":true,"type":"string","name":"server-ssl-profile-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Retrieve a load balancer server-ssl profile","x-vmw-nsx-module":"LoadBalancer","consumes":["application/json"],"operationId":"ReadLoadBalancerServerSslProfile"}},"/dns/forwarders":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DnsForwarder"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Create a DNS forwader upon a logical router. There is only\none DNS forwarder can be created upon a given logical router.\n","parameters":[{"schema":{"$ref":"#/definitions/DnsForwarder"},"required":true,"name":"DnsForwarder","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","DNS"],"summary":"Create a DNS forwader","x-vmw-nsx-module":"DnsForwarder","consumes":["application/json"],"operationId":"CreateDnsForwader"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DnsForwarderListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get a paginated list of DNS forwarders.\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","DNS"],"summary":"Get a paginated list of DNS forwarders","x-vmw-nsx-module":"DnsForwarder","consumes":["application/json"],"operationId":"ListDnsForwaders"}},"/node/services/ssh?action=stop":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the ssh service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","SSH"],"summary":"Restart, start or stop the ssh service","x-vmw-nsx-module":"NodeSSHService","consumes":["application/json"],"operationId":"CreateSSHServiceActionStop"}},"/transport-node-collections/{transport-node-collection-id}?action=retry_profile_realization":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"This API is relevant for compute collection on which vLCM is enabled. This API shpuld be invoked to retry the realization of transport node profile on the compute collection. This is useful when profile realization had failed because of error in vLCM. This API has no effect if vLCM is not enabled on the computer collection.","parameters":[{"required":true,"type":"string","name":"transport-node-collection-id","in":"path"}],"tags":["System Administration","Configuration","Fabric","Nodes","Transport Node Collections"],"summary":"Retry the process on applying transport node profile","x-vmw-nsx-module":"TransportNodeCollection","consumes":["application/json"],"operationId":"RetryTransportNodeCollectionRealization"}},"/vpn/ipsec/sessions/{session-id}/statistics?action=reset":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Reset the statistics of the given VPN session.","parameters":[{"required":true,"type":"string","name":"session-id","in":"path"}],"tags":["Management Plane API","Networking","VPN","Statistics","IPSEC Reset Sessions Statistics"],"summary":"Reset the statistics of the given VPN session","x-vmw-nsx-module":"VPNStatistics","consumes":["application/json"],"operationId":"ResetIPSecVPNSessionStatistics"}},"/intelligence/host-config?action=reset":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IntelligenceHostConfigurationInfo"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Deprecated - Please use the intelligence API /napp/api/v1/intelligence/data-collection/host-config?action=reset\ninstead, after installing NSX Intelligence.\nReset NSX-Intelligence host configuration to the default setting.\nClear NSX-Intelligence host configuration if NSX-Intelligence is not registered with NSX.\nReturn the NSX-Intelligence host configuration after reset operation.\n","produces":["application/json"],"tags":["System Administration","Configuration","NSX Intelligence","Host"],"summary":"Reset NSX-Intelligence host configuration","x-vmw-nsx-module":"NsxIntelligenceHostConfiguration","consumes":["application/json"],"operationId":"ResetPaceHostConfiguration"}},"/node/services/policy?action=start":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Policy Service"],"summary":"Restart, start or stop the service","x-vmw-nsx-module":"NodePolicyService","consumes":["application/json"],"operationId":"CreatePolicyServiceActionStart"}},"/migration/mp-policy-promotion/history":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MPPolicyPromotionHistoryList"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"This api is used to get migration history.\n","produces":["application/json"],"tags":["System Administration","Lifecycle Management","Migration","Plan"],"summary":"This api is used to get mp policy promotion history. The history contains details about date and time of different promotion\noperations like INITIATED, CANCELLED, SUCCESS.\n","x-vmw-nsx-module":"MPPolicyMigration","consumes":["application/json"],"operationId":"GetMPPolicyPromotionHistory"}},"/edge-clusters/{edge-cluster-id}?action=replace_transport_node":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EdgeCluster"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Replace the transport node in the specified member of the edge-cluster.\nThis is a disruptive action. This will move all the LogicalRouterPorts(uplink and routerLink)\nhost on the old transport_node to the new transport_node. The transportNode cannot be\npresent in another member of any edgeClusters.\n","parameters":[{"required":true,"type":"string","name":"edge-cluster-id","in":"path"},{"schema":{"$ref":"#/definitions/EdgeClusterMemberTransportNode"},"required":true,"name":"EdgeClusterMemberTransportNode","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Edge Clusters","Edge Clusters"],"summary":"Replace the transport node in the specified member of the edge-cluster","x-vmw-nsx-module":"EdgeClusters","consumes":["application/json"],"operationId":"ReplaceEdgeClusterMemberTransportNode"}},"/directory/org-units":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DirectoryOrgUnitListResults"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Fetch all organization units for a LDAP server.","parameters":[{"schema":{"$ref":"#/definitions/DirectoryLdapServer"},"required":true,"name":"DirectoryLdapServer","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Directory Service","Domains"],"summary":"Fetch all organization units for a LDAP server.","x-vmw-nsx-module":"DirectoryService","consumes":["application/json"],"operationId":"FetchDirectoryOrgUnits"}},"/migration?action=finalize_infra":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Perform steps that are required to finalize the infra such as remove the temporary security groups, remove other\nobjects created temporarily for the migration.\n","tags":["System Administration","Lifecycle Management","Migration"],"summary":"Perform steps required to finalize the infra.","x-vmw-nsx-module":"Migration","consumes":["application/json"],"operationId":"FinalizeInfra"}},"/logical-routers/{logical-router-id}/routing/bgp/neighbors/{neighbor-id}/routes":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BgpNeighborRouteDetails"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns routes learned by BGP neighbor from all edge transport nodes on which\nthis neighbor is currently enabled. It always returns realtime response.\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"required":true,"type":"string","name":"neighbor-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Logical Routers"],"summary":"Get BGP neighbor learned routes","x-vmw-nsx-module":"AggSvcLogicalRouter","consumes":["application/json"],"operationId":"GetBgpNeighborRoutes"}},"/migration/feedback-response?action=accept-recommended":{"post":{"responses":{"200":{"description":"OK"},"401":{"description":"Unauthorized"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Pick default resolution for all feedback items.\n","parameters":[{"enum":["L2","L3_L7"],"description":"Network layer for which feedback is generated","required":false,"in":"query","type":"string","name":"network_layer"}],"tags":["System Administration","Lifecycle Management","Migration","Feedback"],"summary":"Accept default action for feedbacks","x-vmw-nsx-module":"Migration","consumes":["application/json"],"operationId":"AcceptRecommendedValueInFeedback"}},"/associations":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AssociationListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about resources that are associated with the given\nresource. Id and type of the resource for which associated resources are\nto be fetched are to be specified as query parameter in the URI. Resource\ntype of the associated resources must be specified as query\nparameter.\n","parameters":[{"enum":["NSGroup"],"description":"Resource type valid for use as target in association API","required":true,"in":"query","type":"string","name":"associated_resource_type"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Fetch complete list of associated resources considering\ncontainment and nesting\n","default":false,"required":false,"in":"query","type":"boolean","name":"fetch_ancestors"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"description":"The resource for which associated resources are to be fetched","required":true,"type":"string","name":"resource_id","in":"query"},{"enum":["NSGroup","IPSet","MACSet","LogicalSwitch","LogicalPort","VirtualMachine","DirectoryGroup","VirtualNetworkInterface","TransportNode","IPAddress","CloudNativeServiceInstance","PhysicalServer"],"description":"Resource type valid for use as source in association API","required":true,"in":"query","type":"string","name":"resource_type"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Associations"],"summary":"Get ResourceReference objects to which the given resource belongs to\n","x-vmw-nsx-module":"Association","consumes":["application/json"],"operationId":"GetAssociations"}},"/upgrade/bundles/{bundle-id}/upload-status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UpgradeBundleUploadStatus"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get uploaded upgrade bundle upload status\n","parameters":[{"required":true,"type":"string","name":"bundle-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Upgrade","Bundles"],"summary":"Get uploaded upgrade bundle upload status","x-vmw-nsx-module":"Upgrade","consumes":["application/json"],"operationId":"GetUpgradeBundleUploadStatus"}},"/migration/vmgroup?action=post_migrate":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"For each VM group, the following three high level steps are performed in sequence.\n1. Call pre VM group migrate API.\n2. Migrate (by vmotion,in place, etc.,) VMs in the VM group. This step will be done by user independent of MC.\n3. Call post VM group migrate API with the same VM group id used in the pre VM group migrate API.\nThis API specifically deals with post VM group migrate API. When post VM group migrate API is invoked for a VM group\nid, MC performs following actions.\n - Add security tags on the VMs migrated. For the VMs mentioned in the failed VM instance uuids, this operation is\n skipped.\n","parameters":[{"schema":{"$ref":"#/definitions/PostVmGroupMigrationSpec"},"required":true,"name":"PostVmGroupMigrationSpec","in":"body"}],"tags":["System Administration","Lifecycle Management","Migration","Vmgroup"],"summary":"Perform steps required after migrating a VM group.","x-vmw-nsx-module":"Migration","consumes":["application/json"],"operationId":"PostVmGroupMigrate"}},"/upgrade/plan?action=continue":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"409":{"description":"Conflict"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Continue the upgrade. Resumes the upgrade from the point where\nit was paused.\n","parameters":[{"description":"Component to upgrade.","required":false,"type":"string","name":"component_type","in":"query"},{"description":"Skip to upgrade of next component.","default":false,"required":false,"in":"query","type":"boolean","name":"skip"}],"tags":["System Administration","Lifecycle Management","Upgrade","Plan"],"summary":"Continue upgrade","x-vmw-nsx-module":"Upgrade","consumes":["application/json"],"operationId":"ContinueUpgrade"}},"/bridge-endpoints/{endpoint-id}/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BridgeEndpointStatus"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get the status for the Bridge Endpoint of the given Endpoint id","parameters":[{"required":true,"type":"string","name":"endpoint-id","in":"path"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Bridging","Bridge Endpoints"],"summary":"Returns status of a specified Bridge Endpoint","x-vmw-nsx-module":"AggSvcBridging","consumes":["application/json"],"operationId":"GetBridgeEndpointStatus"}},"/vpn/ipsec/sessions/summary":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IPSecVPNSessionSummary"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"VPN session summary gets summary per vpn sessions and IKE session. Query parameter source supports only cached mode.","parameters":[{"description":"Peer site id","type":"string","name":"site_id","in":"query"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"}],"produces":["application/json"],"tags":["Management Plane API","Networking","VPN","Statistics","IPSEC Sessions Summary"],"summary":"VPN session summary","x-vmw-nsx-module":"VPNStatistics","consumes":["application/json"],"operationId":"GetIPSecVPNSessionSummary"}},"/logical-switches/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LogicalSwitchStatusSummary"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns Operational status of all logical switches.\nThe query parameter \"source=realtime\" is not supported.\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Flag to enable showing of transit logical switch.","default":false,"required":false,"in":"query","type":"boolean","name":"diagnostic"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"},{"enum":["DEFAULT","SERVICE_PLANE","DHCP_RELAY","GLOBAL","INTER_ROUTER","EVPN","DVPG"],"description":"Logical Switch type","required":false,"in":"query","type":"string","name":"switch_type"},{"description":"Switching Profile identifier","required":false,"type":"string","name":"switching_profile_id","in":"query"},{"enum":["OVERLAY","VLAN"],"description":"Mode of transport supported in the transport zone for this logical switch","required":false,"in":"query","type":"string","name":"transport_type"},{"description":"Transport zone identifier","required":false,"type":"string","name":"transport_zone_id","in":"query"},{"description":"The logical switch's uplink teaming policy name","required":false,"type":"string","name":"uplink_teaming_policy_name","in":"query"},{"description":"Virtual Local Area Network Identifier","format":"int64","required":false,"maximum":4094,"minimum":0,"in":"query","type":"integer","name":"vlan"},{"description":"VNI of the OVERLAY LogicalSwitch(es) to return.","format":"int32","required":false,"in":"query","type":"integer","name":"vni"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Switching","Logical Switches"],"summary":"Get Status Summary of All Logical Switches in the System","x-vmw-nsx-module":"AggSvcLogicalSwitch","consumes":["application/json"],"operationId":"GetLogicalSwitchStatusSummary"}},"/transport-nodes/{transport-node-id}/state":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TransportNodeState"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about the current state of the transport node\nconfiguration and information about the associated hostswitch.\nThis api is now deprecated. Please use new api -\n/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/host-transport-nodes/<host-transport-node-id>/state\n","parameters":[{"required":true,"type":"string","name":"transport-node-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Transport Nodes"],"summary":"Get a Transport Node's State","x-vmw-nsx-module":"TransportNodeLcm","consumes":["application/json"],"operationId":"GetTransportNodeStateWithDeploymentInfo"}},"/node/services/cluster_manager?action=start":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the cluster boot manager service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Cluster Manager Service"],"summary":"Restart, start or stop the cluster boot manager service","x-vmw-nsx-module":"NodeClusterBootManagerService","consumes":["application/json"],"operationId":"CreateClusterBootManagerServiceActionStart"}},"/firewall/status/{context-type}/{id}?action=disable_firewall":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TargetResourceStatus"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"description":"Bad Request"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Disable firewall on target resource in dfw context","parameters":[{"required":true,"type":"string","name":"context-type","in":"path"},{"required":true,"type":"string","name":"id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Firewall"],"summary":"Disable firewall on target resource in dfw context","x-vmw-nsx-module":"FirewallStatus","consumes":["application/json"],"operationId":"DisableFirewallOnTargetResource"}},"/firewall/excludelist":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ExcludeList"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Modify exclude list.","parameters":[{"schema":{"$ref":"#/definitions/ExcludeList"},"required":true,"name":"ExcludeList","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Firewall"],"summary":"Modify exclude list.","x-vmw-nsx-module":"ExcludeList","consumes":["application/json"],"operationId":"UpdateExcludeList"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ExcludeList"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get list of entities in exclude list.","produces":["application/json"],"tags":["Management Plane API","Security","Services","Firewall"],"summary":"Get list of entities in exclude list.","x-vmw-nsx-module":"ExcludeList","consumes":["application/json"],"operationId":"GetExcludeList"}},"/livetraces":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/LiveTraceStatus"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Create a livetrace session","parameters":[{"schema":{"$ref":"#/definitions/LiveTraceRequest"},"required":true,"name":"LiveTraceRequest","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Troubleshooting And Monitoring","Livetrace"],"summary":"Create a livetrace session","x-vmw-nsx-module":"LiveTrace","consumes":["application/json"],"operationId":"CreateLiveTrace"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LiveTraceListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"List all livetrace sessions","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Troubleshooting And Monitoring","Livetrace"],"summary":"List all livetrace sessions","x-vmw-nsx-module":"LiveTrace","consumes":["application/json"],"operationId":"ListLiveTrace"}},"/serviceinsertion/services/{service-id}/solution-configs/{solution-config-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SolutionConfig"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Updates a solution config. Solution Config are service level objects,\nrequired for configuring the NXGI partner Service after deployment.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"required":true,"type":"string","name":"solution-config-id","in":"path"},{"schema":{"$ref":"#/definitions/SolutionConfig"},"required":true,"name":"SolutionConfig","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Updates Solution Config for a given Service","x-vmw-nsx-module":"Nxgi","consumes":["application/json"],"operationId":"UpdateSolutionConfig"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SolutionConfig"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns Solution Config information for a given solution config id.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"required":true,"type":"string","name":"solution-config-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Get Solution Config Information for a given solution config id.","x-vmw-nsx-module":"Nxgi","consumes":["application/json"],"operationId":"GetSolutionConfig"},"delete":{"responses":{"200":{"description":"OK"},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Deletes solution config information for a given service.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"required":true,"type":"string","name":"solution-config-id","in":"path"}],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Deletes solution config information.","x-vmw-nsx-module":"Nxgi","consumes":["application/json"],"operationId":"DeleteSolutionConfig"}},"/node/services/manager?action=stop":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Manager Service"],"summary":"Restart, start or stop the service","x-vmw-nsx-module":"NodeProtonService","consumes":["application/json"],"operationId":"CreateProtonServiceActionStop"}},"/migration/migration-unit-groups/{group-id}/migration-unit/{migration-unit-id}?action=reorder":{"post":{"responses":{"200":{"description":"OK"},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Reorder an migration unit within the migration unit group by placing it\nbefore/after the specified migration unit\n","parameters":[{"required":true,"type":"string","name":"group-id","in":"path"},{"required":true,"type":"string","name":"migration-unit-id","in":"path"},{"schema":{"$ref":"#/definitions/ReorderMigrationRequest"},"required":true,"name":"ReorderMigrationRequest","in":"body"}],"tags":["System Administration","Lifecycle Management","Migration","Group"],"summary":"Reorder an migration unit within the migration unit group","x-vmw-nsx-module":"Migration","consumes":["application/json"],"operationId":"ReorderMigrationUnit"}},"/lldp/fabric-nodes/{fabric-node-id}/interfaces/{interface-name}":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/InterfaceNeighborProperties"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read LLDP Neighbor Properties for a specific interface of Fabric Node\n","parameters":[{"description":"ID of fabric node","required":true,"type":"string","name":"fabric-node-id","in":"path"},{"description":"Interface name to read","required":true,"type":"string","name":"interface-name","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","LLDP"],"summary":"Read LLDP Neighbor Properties of Fabric Node by Interface Name","x-vmw-nsx-module":"Lldp","consumes":["application/json"],"operationId":"ReadFabricNodeNeighborProperties"}},"/logical-routers/{logical-router-id}/routing/route-table":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LogicalRouterRouteTable"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Deprecated - Please use /logical-routers/<logical-router-id>/routing/routing-table for RIB and\n/logical-routers/<logical-router-id>/routing/forwarding-table for FIB.\nReturns the route table for the logical router on a node of the given transport-node-id.\nQuery parameter \"transport_node_id=<transport-node-id>\" is required.\nQuery parameter \"source=realtime\" is the only supported source.\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"},{"description":"TransportNode Id","required":true,"type":"string","name":"transport_node_id","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Logical Routers"],"summary":"Get route table on a given node for a logical router","x-vmw-nsx-module":"AggSvcLogicalRouter","consumes":["application/json"],"operationId":"GetLogicalRouterRouteTable"}},"/fabric/compute-collections/{cc-ext-id}":{"post":{"responses":{"200":{"description":"OK"},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Perform action specific to NSX on the compute-collection. cc-ext-id should be of type VC_Cluster.","parameters":[{"required":true,"type":"string","name":"cc-ext-id","in":"path"},{"description":"Supported actions on compute-collection","enum":["remove_nsx"],"type":"string","name":"action","in":"query"}],"tags":["System Administration","Configuration","Fabric","Compute Collections"],"summary":"Perform action specific to NSX on the compute-collection. cc-ext-id should be of type VC_Cluster.","x-vmw-nsx-module":"ComputeCollectionDeployment","consumes":["application/json"],"operationId":"PerformActionOnComputeCollection"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ComputeCollection"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about a specific compute collection.","parameters":[{"required":true,"type":"string","name":"cc-ext-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Compute Collections"],"summary":"Return Compute Collection Information","x-vmw-nsx-module":"InventoryCmObj","consumes":["application/json"],"operationId":"ReadComputeCollection"}},"/logical-routers/{logical-router-id}/routing/ip-prefix-lists":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IPPrefixList"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Adds a new IPPrefixList on a Logical Router\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"schema":{"$ref":"#/definitions/IPPrefixList"},"required":true,"name":"IPPrefixList","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Routing Configuration"],"summary":"Add IPPrefixList on a Logical Router","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"AddIPPrefixList"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IPPrefixListListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Paginated List of IPPrefixLists","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Routing Configuration"],"summary":"Paginated List of IPPrefixLists","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"ListIPPrefixLists"}},"/vpn/ipsec/sessions/{ipsec-vpn-session-id}/state":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IPSecVPNSessionState"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Return realized state information of a ipsec vpn session.\nAny configuration update that affects the ipsec vpn session can use this API\nto get its realized state by passing a request_id returned by the\nconfiguration change operation. e.g. Update configuration of ipsec vpn session,\nservice, endpoints, profiles, etc.\nIt will return a service disabled error, if the ipsec vpn service associated\nwith the session is disabled.\n","parameters":[{"required":true,"type":"string","name":"ipsec-vpn-session-id","in":"path"},{"name":"barrier_id","format":"int64","required":false,"minimum":0,"in":"query","type":"integer"},{"description":"Realization request ID","required":false,"type":"string","name":"request_id","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","VPN","IPSEC","Sessions"],"summary":"Get the Realized State of a IPSec VPN Session","x-vmw-nsx-module":"IPSecVPN","consumes":["application/json"],"operationId":"GetIPSecVPNSessionState"}},"/node/network/interfaces":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeNetworkInterfacePropertiesListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the number of interfaces on the node appliance and detailed\ninformation about each interface. Interface information includes MTU,\nbroadcast and host IP addresses, link and admin status, MAC address, network\nmask, and the IP configuration method (static or DHCP).\n","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Network Interfaces"],"summary":"List the Node's Network Interfaces","x-vmw-nsx-module":"NetworkInterfaceModule","consumes":["application/json"],"operationId":"ListNodeInterfaces"}},"/trust-management/csrs?action=self_sign":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/Certificate"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Creates a new self-signed certificate. A private key is also created at the\nsame time. This is convenience call that will generate a CSR and then self-sign it.\nFor validity of non-CA certificates, if a value greater than 825 days is\nprovided, it will be set to 825 days. No limit is set for CA certificates.\n","parameters":[{"schema":{"$ref":"#/definitions/CsrWithDaysValid"},"required":true,"name":"CsrWithDaysValid","in":"body"}],"produces":["application/json"],"tags":["System Administration","Settings","Certificates","CSR"],"summary":"Generate a New Self-Signed Certificate","x-vmw-nsx-module":"CertificateManager","consumes":["application/json"],"operationId":"GenerateSelfSignedCertificate"}},"/serviceinsertion/sections?action=create_with_rules":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/ServiceInsertionSectionRuleList"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Creates a new serviceinsertion section with rules. The limit on the number of\nrules is defined by maxItems in collection types for ServiceInsertionRule\n(ServiceInsertionRuleXXXList types). When invoked on a section with a large number\nof rules, this API is supported only at low rates of invocation (not more\nthan 4-5 times per minute). The typical latency of this API with about 1024\nrules is about 4-5 seconds. This API should not be invoked with large\npayloads at automation speeds. More than 50 rules are not supported.\n\nInstead, to create sections, use:\nPOST /api/v1/serviceinsertion/sections\n\nTo create rules, use:\nPOST /api/v1/serviceinsertion/sections/<section-id>/rules\nNote- POST service insertion section creation with rules API is deprecated.\nPlease use policy redirection-policy API.\n","parameters":[{"schema":{"$ref":"#/definitions/ServiceInsertionSectionRuleList"},"required":true,"name":"ServiceInsertionSectionRuleList","in":"body"},{"in":"query","description":"Identifier of the anchor rule or section. This is a required field in case operation like 'insert_before' and 'insert_after'.","required":false,"maxLength":64,"type":"string","name":"id"},{"enum":["insert_top","insert_bottom","insert_after","insert_before"],"description":"Operation","default":"insert_top","required":false,"in":"query","type":"string","name":"operation"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Create a Section with Rules","x-vmw-nsx-module":"ServiceInsertionRules","consumes":["application/json"],"operationId":"AddServiceInsertionSectionWithRules"}},"/dhcp/servers/{server-id}/ipv6-ip-pools/{pool-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DhcpV6IpPool"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update a specific ip pool of a given logical DHCP IPv6 server.","parameters":[{"required":true,"type":"string","name":"server-id","in":"path"},{"required":true,"type":"string","name":"pool-id","in":"path"},{"schema":{"$ref":"#/definitions/DhcpV6IpPool"},"required":true,"name":"DhcpV6IpPool","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","DHCP"],"summary":"Update a DHCP IPv6 server's IP pool","x-vmw-nsx-module":"Dhcp","consumes":["application/json"],"operationId":"UpdateDhcpV6IpPool"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete a specific ip pool of a given logical DHCP IPv6 server.","parameters":[{"required":true,"type":"string","name":"server-id","in":"path"},{"required":true,"type":"string","name":"pool-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","DHCP"],"summary":"Delete a DHCP IPv6 server's IP pool","x-vmw-nsx-module":"Dhcp","consumes":["application/json"],"operationId":"DeleteDhcpV6IpPool"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DhcpV6IpPool"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Return a specific ip pool of a given logical DHCP IPv6 server.","parameters":[{"required":true,"type":"string","name":"server-id","in":"path"},{"required":true,"type":"string","name":"pool-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","DHCP"],"summary":"Get a DHCP IPv6 server's IP pool with the specified pool ID","x-vmw-nsx-module":"Dhcp","consumes":["application/json"],"operationId":"ReadDhcpV6IpPool"}},"/fabric/ostypes":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SupportedHostOSListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns names of all supported host OS.","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Fabric Nodes"],"summary":"Return list of supported host OS types","x-vmw-nsx-module":"HostPrepServiceFabric","consumes":["application/json"],"operationId":"GetSupportedHostOSTypes"}},"/ip-sets":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/IPSet"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Creates a new IPSet that can group either IPv4 or IPv6 individual ip addresses,\nranges or subnets.\n","parameters":[{"schema":{"$ref":"#/definitions/IPSet"},"required":true,"name":"IPSet","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Grouping Objects","NS Profiles"],"summary":"Create IPSet","x-vmw-nsx-module":"IPSet","consumes":["application/json"],"operationId":"CreateIPSet"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IPSetListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns paginated list of IPSets\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Grouping Objects","IP Sets"],"summary":"List IPSets","x-vmw-nsx-module":"IPSet","consumes":["application/json"],"operationId":"ListIPSets"}},"/bridge-endpoint-profiles/{bridgeendpointprofile-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BridgeEndpointProfile"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Modifies a existing bridge endpoint profile.\n","parameters":[{"required":true,"type":"string","name":"bridgeendpointprofile-id","in":"path"},{"schema":{"$ref":"#/definitions/BridgeEndpointProfile"},"required":true,"name":"BridgeEndpointProfile","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Bridging","Bridge Endpoint Profiles"],"summary":"Update a Bridge Endpoint Profile","x-vmw-nsx-module":"BridgeEndpointProfile","consumes":["application/json"],"operationId":"UpdateBridgeEndpointProfile"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BridgeEndpointProfile"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about a specified bridge endpoint profile.","parameters":[{"required":true,"type":"string","name":"bridgeendpointprofile-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Bridging","Bridge Endpoint Profiles"],"summary":"Get Information about a bridge endpoint Profile","x-vmw-nsx-module":"BridgeEndpointProfile","consumes":["application/json"],"operationId":"GetBridgeEndpointProfile"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Deletes the specified Bridge Endpoint Profile.","parameters":[{"required":true,"type":"string","name":"bridgeendpointprofile-id","in":"path"}],"tags":["Management Plane API","Networking","Logical Bridging","Bridge Endpoint Profiles"],"summary":"Delete a Bridge Endpoint Profile","x-vmw-nsx-module":"BridgeEndpointProfile","consumes":["application/json"],"operationId":"DeleteBridgeEndpointProfile"}},"/cluster/api-service":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ApiServiceConfig"}},"202":{"description":"Accepted","schema":{"$ref":"#/definitions/ApiServiceConfig"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read the configuration of the NSX API service. Changes are applied to all nodes in the cluster. The API service on each node will restart after it is updated using this API. There may be a delay of up to a minute or so between the time this API call completes and when the new configuration goes into effect.","parameters":[{"schema":{"$ref":"#/definitions/ApiServiceConfig"},"required":true,"name":"ApiServiceConfig","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","NSX Managers","API Services","Configuration"],"summary":"Update API service properties","x-vmw-nsx-module":"ClusterApiServiceModule","consumes":["application/json"],"operationId":"UpdateApiServiceConfig"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ApiServiceConfig"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read the configuration of the NSX API service.\n","produces":["application/json"],"tags":["System Administration","Configuration","NSX Managers","API Services","Configuration"],"summary":"Read API service properties","x-vmw-nsx-module":"ClusterApiServiceModule","consumes":["application/json"],"operationId":"GetApiServiceConfig"}},"/alarms?action=set_status":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"description":"Bad Request"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Bulk update the status of zero or more Alarms that match the specified filters. The new_status value can be OPEN, ACKNOWLEDGED, SUPPRESSED, or RESOLVED. If new_status is SUPPRESSED, the suppress_duration query parameter must also be specified.","parameters":[{"description":"Timestamp in milliseconds since epoch","format":"int64","required":false,"in":"query","type":"integer","name":"after"},{"description":"Timestamp in milliseconds since epoch","format":"int64","required":false,"in":"query","type":"integer","name":"before"},{"description":"Cursor for pagination","required":false,"type":"string","name":"cursor","in":"query"},{"description":"Event Type Filter","required":false,"type":"string","name":"event_type","in":"query"},{"description":"Feature Name","required":false,"type":"string","name":"feature_name","in":"query"},{"description":"Alarm ID","required":false,"type":"string","name":"id","in":"query"},{"description":"Intent Path for entity ID","required":false,"type":"string","name":"intent_path","in":"query"},{"enum":["OPEN","ACKNOWLEDGED","SUPPRESSED","RESOLVED"],"description":"Status","required":true,"in":"query","type":"string","name":"new_status"},{"description":"Node ID","required":false,"type":"string","name":"node_id","in":"query"},{"description":"Node Resource Type","required":false,"type":"string","name":"node_resource_type","in":"query"},{"description":"Page Size for pagination","format":"int64","required":false,"in":"query","type":"integer","name":"page_size"},{"description":"Severity","required":false,"type":"string","name":"severity","in":"query"},{"description":"Represents order of sorting the values","default":true,"required":false,"in":"query","type":"boolean","name":"sort_ascending"},{"description":"Key for sorting on this column","required":false,"type":"string","name":"sort_by","in":"query"},{"description":"Status","required":false,"type":"string","name":"status","in":"query"},{"description":"Duration in hours for which Alarm should be suppressed","format":"int64","type":"integer","name":"suppress_duration","in":"query"}],"produces":["application/json"],"tags":["System Administration","Monitoring","Alarms And Events"],"summary":"Bulk update the status of zero or more Alarms.","x-vmw-nsx-module":"Monitoring","consumes":["application/json"],"operationId":"BulkUpdateAlarms"}},"/pktcap/session/{session-id}/capturefile":{"get":{"responses":{"200":{"description":"OK"},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"You must provide the request header\n\"Accept:application/octet-stream\" when calling this API.\nThe capture file can only be found in MP which receives the capture request.\n","parameters":[{"description":"Packet capture session id","required":true,"type":"string","name":"session-id","in":"path"}],"produces":["application/octet-stream"],"tags":["Management Plane API","Troubleshooting And Monitoring","Packet Capture"],"summary":"Get packet capture file","x-vmw-nsx-module":"PacketCapture","consumes":["application/json"],"operationId":"GetCaptureFile"}},"/serviceinsertion/services/{service-id}/solution-configs":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SolutionConfig"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Adds a solution config. Solution Config are service level objects,\nrequired for configuring the NXGI partner Service after deployment.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"schema":{"$ref":"#/definitions/SolutionConfig"},"required":true,"name":"SolutionConfig","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Add Solution Config for a given Service","x-vmw-nsx-module":"Nxgi","consumes":["application/json"],"operationId":"CreateSolutionConfig"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SolutionConfigListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns Solution Config information for a given service.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Get Solution Config Information associated with a given service.","x-vmw-nsx-module":"Nxgi","consumes":["application/json"],"operationId":"ListSolutionConfigs"}},"/vpn/l2vpn/services/{l2vpn-service-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/L2VpnService"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Edit a specific L2VPN service","parameters":[{"required":true,"type":"string","name":"l2vpn-service-id","in":"path"},{"schema":{"$ref":"#/definitions/L2VpnService"},"required":true,"name":"L2VpnService","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","VPN","L2VPN","Services"],"summary":"Edit a L2VPN service","x-vmw-nsx-module":"L2VPN","consumes":["application/json"],"operationId":"UpdateL2VpnService"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete a specific L2VPN service. If there are any L2VpnSessions on this L2VpnService, those needs to be deleted first.","parameters":[{"required":true,"type":"string","name":"l2vpn-service-id","in":"path"},{"default":false,"description":"Force delete the resource even if it is being used somewhere\n","type":"boolean","name":"force","in":"query"}],"tags":["Management Plane API","Networking","VPN","L2VPN","Services"],"summary":"Delete a L2VPN service","x-vmw-nsx-module":"L2VPN","consumes":["application/json"],"operationId":"DeleteL2VpnService"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/L2VpnService"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get a specific L2VPN service","parameters":[{"required":true,"type":"string","name":"l2vpn-service-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","VPN","L2VPN","Services"],"summary":"Get L2VPN service","x-vmw-nsx-module":"L2VPN","consumes":["application/json"],"operationId":"GetL2VpnService"}},"/eula/accept":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Accept end user license agreement\n","produces":["application/json"],"tags":["System Administration","Settings","Licenses"],"summary":"Accept end user license agreement\n","x-vmw-nsx-module":"EULA","consumes":["application/json"],"operationId":"AcceptEULA"}},"/loadbalancer/node-usage-summary":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LbNodeUsageSummary"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"API is used to retrieve the load balancer node usage summary for all nodes.\n","parameters":[{"description":"Whether to include node usages","required":false,"type":"boolean","name":"include_usages","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Read load balancer node usage summary","x-vmw-nsx-module":"LoadBalancer","consumes":["application/json"],"operationId":"ReadLoadBalancerNodeUsageSummary"}},"/transport-nodes/{edge-node-id}/inter-site/bgp/neighbors/{neighbor-id}/advertised-routes":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BgpNeighborRouteDetails"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns routes advertised by BGP neighbor from the given edge transport node.\nIt always returns realtime response.\n","parameters":[{"required":true,"type":"string","name":"edge-node-id","in":"path"},{"required":true,"type":"string","name":"neighbor-id","in":"path"}],"produces":["application/json"],"tags":["Federation","Inter-Sites"],"summary":"Get BGP neighbor advertised routes on edge transport node","x-vmw-nsx-module":"AggSvcInterSite","consumes":["application/json"],"operationId":"GetInterSiteEdgeNodeBgpNeighborAdvertisedRoutes"}},"/transport-nodes/{node-id}/tunnels/{tunnel-name}":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TunnelProperties"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Tunnel properties","parameters":[{"description":"ID of transport node","required":true,"type":"string","name":"node-id","in":"path"},{"description":"Tunnel name","required":true,"type":"string","name":"tunnel-name","in":"path"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Transport Node Tunnels"],"summary":"Tunnel properties","x-vmw-nsx-module":"Tunnel","consumes":["application/json"],"operationId":"GetTunnel"}},"/firewall/sections/{section-id}?action=unlock":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FirewallSection"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"423":{"description":"Locked"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Unlock a section.\n","parameters":[{"required":true,"type":"string","name":"section-id","in":"path"},{"schema":{"$ref":"#/definitions/FirewallSectionLock"},"required":true,"name":"FirewallSectionLock","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Firewall"],"summary":"Unlock a section","x-vmw-nsx-module":"Firewall","consumes":["application/json"],"operationId":"UnlockSection"}},"/pools/vtep-label-pools":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/VtepLabelPoolListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns a list of all virtual tunnel endpoint label pools\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Pool Management","VTEP Label Pools"],"summary":"List virtual tunnel endpoint Label Pools","x-vmw-nsx-module":"VtepLabel","consumes":["application/json"],"operationId":"ListVtepLabelPools"}},"/migration/plan?action=reset":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Reset the migration plan to default plan. User has an option to change\nthe default plan. But if after making changes, user wants to go\nback to the default plan, this is the way to do so.\n","parameters":[{"description":"Component type","required":true,"type":"string","name":"component_type","in":"query"}],"tags":["System Administration","Lifecycle Management","Migration","Plan"],"summary":"Reset migration plan to default plan","x-vmw-nsx-module":"Migration","consumes":["application/json"],"operationId":"ResetMigrationPlan"}},"/node/users/{userid}?action=deactivate":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeUserProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"409":{"description":"Conflict"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"description":"Service Unavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Deactivates the account for this user. Deactivating an account is\npermanent, unlike an account that is temporarily locked because of\ntoo many password failures. A deactivated account has to be explicitly\nactivated. When an account is successfully deactivated, the \"status\"\nfield in the response is \"NOT_ACTIVATED\".\nThis API is not supported for userid 0 and userid 10000.\n","parameters":[{"description":"User id of the user","required":true,"type":"string","name":"userid","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","User Management","Users"],"summary":"Deactivate a user account","x-vmw-nsx-module":"NodeUsersManagerNodeType","consumes":["application/json"],"operationId":"DeactivateNodeUserDeactivate"}},"/firewall/sections?action=create_with_rules":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/FirewallSectionRuleList"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Creates a new firewall section with rules. The limit on the number of\nrules is defined by maxItems in collection types for FirewallRule\n(FirewallRuleXXXList types). When invoked on a section with a large number\nof rules, this API is supported only at low rates of invocation (not more\nthan 4-5 times per minute). The typical latency of this API with about 1024\nrules is about 4-5 seconds. This API should not be invoked with large\npayloads at automation speeds. More than 50 rules with a large number of\nrule references is not supported.\n\nInstead, to create sections, use:\nPOST /api/v1/firewall/sections\n\nTo create rules, use:\nPOST /api/v1/firewall/sections/<section-id>/rules\n","parameters":[{"schema":{"$ref":"#/definitions/FirewallSectionRuleList"},"required":true,"name":"FirewallSectionRuleList","in":"body"},{"in":"query","description":"Identifier of the anchor rule or section. This is a required field in case operation like 'insert_before' and 'insert_after'.","required":false,"maxLength":64,"type":"string","name":"id"},{"enum":["insert_top","insert_bottom","insert_after","insert_before"],"description":"Operation","default":"insert_top","required":false,"in":"query","type":"string","name":"operation"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Firewall"],"summary":"Create a Section with Rules.","x-vmw-nsx-module":"Firewall","consumes":["application/json"],"operationId":"AddSectionWithRules"}},"/logical-switches/{logical-switch-id}/inter-site-forwarder/statistics":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/L2ForwarderStatistics"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns statistics of the l2 forwarder on logical switch.\nIt always returns realtime response.\n","parameters":[{"required":true,"type":"string","name":"logical-switch-id","in":"path"}],"produces":["application/json"],"tags":["Federation","Inter-Sites"],"summary":"Get L2 forwarder statistics","x-vmw-nsx-module":"AggSvcL2Forwarder","consumes":["application/json"],"operationId":"GetL2ForwarderStatistics"}},"/node/upgrade/progress-status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UpgradeProgressStatus"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"description":"Internal Server Error"}},"description":"Get progress status of last upgrade step, if upgrade bundle is present.\n","produces":["application/json"],"tags":["System Administration","Lifecycle Management","Upgrade","Nodes"],"summary":"Get upgrade progress status","x-vmw-nsx-module":"UpgradeNodeActions","consumes":["application/json"],"operationId":"GetUpgradeProgressStatus"}},"/node/network/search-domains":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeSearchDomainsProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"409":{"description":"Conflict"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Modifies the list of domain names that the node uses to complete\nunqualified host names. If DHCP is configured, this method returns\na 409 CONFLICT error, because DHCP manages the list of name servers.\n","parameters":[{"schema":{"$ref":"#/definitions/NodeSearchDomainsProperties"},"required":true,"name":"NodeSearchDomainsProperties","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","DNS"],"summary":"Update the Node's Search Domains","x-vmw-nsx-module":"NodeNetworkDnsModule","consumes":["application/json"],"operationId":"UpdateNodeSearchDomains"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeSearchDomainsProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the domain list that the node uses to complete\nunqualified host names. When a host name does not include a fully\nqualified domain name (FQDN), the NSX Management node appends the\nfirst-listed domain name to the host name before the host name is looked\nup. The NSX Management node continues this for each entry in the domain\nlist until it finds a match.\n","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","DNS"],"summary":"Read the Node's Search Domains","x-vmw-nsx-module":"NodeNetworkDnsModule","consumes":["application/json"],"operationId":"ReadNodeSearchDomains"}},"/repository/bundles/{bundle-id}?action=cancel_upload":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"description":"Internal Server Error"}},"description":"Cancel upload of bundle. This API works only when bundle upload is\nin-progress and will not work during post-processing of bundle. If\nbundle upload is in-progress, then the API call returns http OK response\nafter cancelling the upload and deleting partially uploaded bundle.\n","parameters":[{"required":true,"type":"string","name":"bundle-id","in":"path"},{"enum":["SAMPLE","ALB_CONTROLLER","INTELLIGENCE"],"description":"Name of the appliance","required":true,"in":"query","type":"string","name":"product"}],"tags":["System Administration","Configuration","NSX Intelligence","Repository","Bundles"],"summary":"Cancel bundle upload","x-vmw-nsx-module":"FileUploadFramework","consumes":["application/json"],"operationId":"CancelBundleUpload"}},"/realization-state-barrier/current?action=increment":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/CurrentRealizationStateBarrier"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Increment the current barrier number by 1 for NSX.\nThis method has been deprecated. To track realization state, use\nX-NSX-REQUESTID request header instead.\n","produces":["application/json"],"tags":["System Administration","Configuration","System Properties","Realization State Barrier"],"summary":"Increments the barrier count by 1","x-vmw-nsx-module":"RealizationStateBarrier","consumes":["application/json"],"operationId":"IncrementRealizationStateBarrier"}},"/transport-nodes/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/HeatMapTransportZoneStatus"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get high-level summary of all transport nodes. The service layer does not support source = realtime or cached.","parameters":[{"description":"Transport node type","enum":["HOST","EDGE"],"type":"string","name":"node_type","in":"query"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Transport Node Status"],"summary":"Get high-level summary of all transport nodes. The service layer does not support source = realtime or cached.","x-vmw-nsx-module":"Heatmap","consumes":["application/json"],"operationId":"GetAllTransportNodesStatus"}},"/ns-groups/{ns-group-id}/effective-logical-switch-members":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EffectiveMemberResourceListResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns effective logical switch members of the specified NSGroup.\nThis API is applicable for NSGroups containing LogicalSwitch members.\nFor NSGroups containing other member types,it returns an empty list.\n","parameters":[{"description":"NSGroup Id","required":true,"type":"string","name":"ns-group-id","in":"path"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Grouping Objects","NS Groups"],"summary":"Get Effective switch members translated from the NSGroup","x-vmw-nsx-module":"NSGroup","consumes":["application/json"],"operationId":"GetEffectiveLogicalSwitchMembers"}},"/service-configs/batch":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/ServiceConfigListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Creates/Updates new service configs sent in batch request.\nThis API returns ALL the service configs that are created/updated.\n","parameters":[{"schema":{"$ref":"#/definitions/ServiceConfigList"},"required":true,"name":"ServiceConfigList","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Security","Service Configuration"],"summary":"Creates/Updates service configs sent in batch request","x-vmw-nsx-module":"ServiceConfig","consumes":["application/json"],"operationId":"ServiceConfigBatchOperation"}},"/migration/migration-unit-groups-status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MigrationUnitGroupStatusListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get migration status for migration unit groups","parameters":[{"description":"Component type based on which migration unit groups to be filtered","required":false,"type":"string","name":"component_type","in":"query"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Migration","Group"],"summary":"Get migration status for migration unit groups","x-vmw-nsx-module":"Migration","consumes":["application/json"],"operationId":"GetMigrationUnitGroupsStatus"}},"/intelligence/nodes/deployments/{node-id}/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IntelligenceClusterNodeVMDeploymentStatusReport"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the current deployment or undeployment status for a VM along with\nany other relevant current information, such as error messages.\n","parameters":[{"required":true,"type":"string","name":"node-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","NSX Intelligence","Deployments"],"summary":"Returns the status of the VM creation/deletion","x-vmw-nsx-module":"NsxIntelligenceDeployment","consumes":["application/json"],"operationId":"ReadPaceClusterNodeVMDeploymentStatus"}},"/serviceinsertion/services/{service-id}/service-deployments/{service-deployment-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ServiceDeployment"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"This API is deprecated since only property we can change on service deployment\nis display name, which is used for the SVM name. Changing the name will\ncause the name of the deployment to go out of sync with the deployed VM.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"required":true,"type":"string","name":"service-deployment-id","in":"path"},{"schema":{"$ref":"#/definitions/ServiceDeployment"},"required":true,"name":"ServiceDeployment","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Update an existing Service Deployment.","x-vmw-nsx-module":"ServiceInsertionVMDeployment","consumes":["application/json"],"operationId":"UpdateServiceDeployment"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ServiceDeployment"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns detail of service deployment.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"required":true,"type":"string","name":"service-deployment-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Get a particular service deployment.","x-vmw-nsx-module":"ServiceInsertionVMDeployment","consumes":["application/json"],"operationId":"GetServiceDeployment"},"delete":{"responses":{"202":{"description":"Accepted"},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Remove the service deployment. Will remove all the Service VMs that were\ncreated as part of this deployment. User can send optional force delete\noption which will force remove the deployment, but should be used\nonly when the regular delete is not working. Regular delete will ensure\nproper cleanup of Service VMs and related objects. Directly calling this\nAPI without trying regular undeploy will result in unexpected results,\nand orphan objects.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"required":true,"type":"string","name":"service-deployment-id","in":"path"},{"default":false,"description":"Force delete the resource even if it is being used somewhere\n","type":"boolean","name":"force","in":"query"}],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Remove service deployment","x-vmw-nsx-module":"ServiceInsertionVMDeployment","consumes":["application/json"],"operationId":"DeleteServiceDeployment"}},"/node/services/idps-reporting?action=start":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the idps-reporting service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Idps Reporting Service"],"summary":"Restart, start or stop the idps-reporting service","x-vmw-nsx-module":"IdpsReportingService","consumes":["application/json"],"operationId":"CreateIdpsReportingServiceActionStart"}},"/logical-routers/{logical-router-id}/routing/bgp/neighbors":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BgpNeighbor"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Add a new BGP Neighbor on a Logical Router\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"schema":{"$ref":"#/definitions/BgpNeighbor"},"required":true,"name":"BgpNeighbor","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Routing Configuration"],"summary":"Add a new BGP Neighbor on a Logical Router","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"AddBgpNeighbor"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BgpNeighborListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Paginated list of BGP Neighbors on a Logical Router\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Routing Configuration"],"summary":"Paginated list of BGP Neighbors on a Logical Router","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"ListBgpNeighbors"}},"/transport-nodes/{node-id}/remote-transport-node-status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TransportNodeStatusListResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read status of all transport nodes with tunnel connections to transport node\n","parameters":[{"description":"ID of transport node","required":true,"type":"string","name":"node-id","in":"path"},{"description":"BFD diagnostic code of Tunnel","enum":["0","NO_DIAGNOSTIC","1","CONTROL_DETECTION_TIME_EXPIRED","2","ECHO_FUNCTION_FAILED","3","NEIGHBOR_SIGNALED_SESSION_DOWN","4","FORWARDING_PLANE_RESET","5","PATH_DOWN","6","CONCATENATED_PATH_DOWN","7","ADMINISTRATIVELY_DOWN","8","REVERSE_CONCATENATED_PATH_DOWN"],"type":"string","name":"bfd_diagnostic_code","in":"query"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"},{"description":"Tunnel Status","enum":["UP","DOWN"],"type":"string","name":"tunnel_status","in":"query"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Transport Node Status"],"summary":"Read status of all transport nodes with tunnel connections to transport node\n","x-vmw-nsx-module":"Heatmap","consumes":["application/json"],"operationId":"ListRemoteTransportNodeStatus"}},"/migration/migrated-resources":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MigratedObjectListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"List migrated resources.This API is applicable for mp2Policy migration mode only.\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"description":"Resource id","required":false,"type":"string","name":"resource_id","in":"query"},{"enum":["IPBLOCK","IPPOOL","IPBLOCK_SUBNET","IPPOOL_ALLOCATION","TIER0","TIER1","TIER0_LOGICAL_ROUTER_PORT","TIER1_LOGICAL_ROUTER_PORT","TIER0_LOGICAL_ROUTER_CONFIG","SPOOFGUARD_PROFILES","LOGICAL_SWITCH","LOGICAL_PORT","NAT","IP_SET","NS_GROUP","CERTIFICATE","CRL","LB_MONITOR","LB_POOL","LB_PERSISTENCE_PROFILE","LB_APPLICATION_PROFILE","LB_SERVICE","LB_CLIENT_SSL_PROFILE","LB_VIRTUAL_SERVER","DFW_SECTION"],"description":"Resource type","required":true,"in":"query","type":"string","name":"resource_type"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Migration","Plan"],"summary":"List migrated resources","x-vmw-nsx-module":"MPPolicyMigration","consumes":["application/json"],"operationId":"ListMigratedResources"}},"/migration/plan?action=pause":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"409":{"description":"Conflict"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Pause the migration. Migration will be paused after migration of all\nthe nodes currently in progress is completed either successfully\nor with failure. User can make changes in the migration plan when\nthe migration is paused.\n","tags":["System Administration","Lifecycle Management","Migration","Plan"],"summary":"Pause migration","x-vmw-nsx-module":"Migration","consumes":["application/json"],"operationId":"PauseMigration"}},"/transport-node-profiles":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/TransportNodeProfile"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Transport node profile captures the configuration needed to create\na transport node. A transport node profile can be attached to\ncompute collections for automatic TN creation of member hosts.\nThis api is now deprecated. Please use new api -\n/policy/api/v1/infra/host-transport-node-profiles/<host-transport-node-profile-id>\n","parameters":[{"schema":{"$ref":"#/definitions/TransportNodeProfile"},"required":true,"name":"TransportNodeProfile","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Profiles","Transport Node Profiles"],"summary":"Create a Transport Node Profile","x-vmw-nsx-module":"TransportNodeProfile","consumes":["application/json"],"operationId":"CreateTransportNodeProfile"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TransportNodeProfileListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about all transport node profiles.\nThis api is now deprecated. Please use new api -\n/policy/api/v1/infra/host-transport-node-profiles\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Profiles","Transport Node Profiles"],"summary":"List Transport Nodes","x-vmw-nsx-module":"TransportNodeProfile","consumes":["application/json"],"operationId":"ListTransportNodeProfiles"}},"/node/services/node-mgmt?action=restart":{"post":{"responses":{"202":{"description":"Accepted"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart the node management service","tags":["System Administration","Configuration","Fabric","Nodes","Services","Node Management"],"summary":"Restart the node management service","x-vmw-nsx-module":"NodeApplianceManagementService","consumes":["application/json"],"operationId":"CreateApplianceManagementServiceActionRestart"}},"/proxy/config":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Proxy"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Updates or creates the proxy configuration, and returns the new configuration.\n","parameters":[{"schema":{"$ref":"#/definitions/Proxy"},"required":true,"name":"Proxy","in":"body"}],"produces":["application/json"],"tags":["System Administration","Settings","Proxy Settings"],"summary":"Creates or updates the proxy configuration","x-vmw-nsx-module":"ProxyConfig","consumes":["application/json"],"operationId":"UpdateProxyConfig"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Proxy"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the proxy configuration.","produces":["application/json"],"tags":["System Administration","Settings","Proxy Settings"],"summary":"Returns the proxy configuration","x-vmw-nsx-module":"ProxyConfig","consumes":["application/json"],"operationId":"GetProxyConfig"}},"/directory/domains/{domain-id}/org-units":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DirectoryOrgUnitListResults"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Fetch all organization units for a Directory domain.","parameters":[{"description":"Directory domain identifier","required":true,"type":"string","name":"domain-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","Directory Service","Domains"],"summary":"Fetch all organization units for a Directory domain.","x-vmw-nsx-module":"DirectoryService","consumes":["application/json"],"operationId":"FetchDirectoryOrgUnitsForDirectoryDomain"}},"/pktcap/session/{session-id}?action=delete":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PacketCaptureSession"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Before calling this method, terminate any running capture session.\n","parameters":[{"description":"Packet capture session id","required":true,"type":"string","name":"session-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Troubleshooting And Monitoring","Packet Capture"],"summary":"Delete the packet capture session by session id.","x-vmw-nsx-module":"PacketCapture","consumes":["application/json"],"operationId":"DeletePacketCaptureSession"}},"/error-resolver/{error_id}":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ErrorResolverInfo"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns some metadata about the given error_id. This includes\ninformation of whether there is a resolver present for the\ngiven error_id and its associated user input data\n","parameters":[{"required":true,"type":"string","name":"error_id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Monitoring","Error Resolver"],"summary":"Fetches metadata about the given error_id","x-vmw-nsx-module":"ErrorResolver","consumes":["application/json"],"operationId":"GetErrorResolverInfo"}},"/logical-routers/{logical-router-id}/state":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LogicalRouterState"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Return realized state information of a logical router.\nAny configuration update that affects the logical router can use this API\nto get its realized state by passing a request_id returned by the\nconfiguration change operation. e.g. Update configuration of logical router,\nstatic routes, etc.\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"name":"barrier_id","format":"int64","required":false,"minimum":0,"in":"query","type":"integer"},{"description":"Realization request ID","required":false,"type":"string","name":"request_id","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Logical Routers"],"summary":"Get the Realized State of a Logical Router","x-vmw-nsx-module":"LogicalRouter","consumes":["application/json"],"operationId":"GetLogicalRouterState"}},"/node/services/ui-service?action=restart":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, Start and Stop the ui service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","User Interface Service"],"summary":"Restart, Start and Stop the ui service","x-vmw-nsx-module":"NodeUiServiceService","consumes":["application/json"],"operationId":"CreateNsxUiServiceServiceActionRestart"}},"/serviceinsertion/excludelist":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SIExcludeList"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Modify exclude list. This includes adding/removing members in the list.\nNote- PUT serviceinsertion excludelist API is deprecated. Please use the\npolicy serviceinsertion excludelist API instead.\n","parameters":[{"schema":{"$ref":"#/definitions/SIExcludeList"},"required":true,"name":"SIExcludeList","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Modify exclude list","x-vmw-nsx-module":"ServiceInsertionExcludeList","consumes":["application/json"],"operationId":"UpdateServiceInsertionExcludeList"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SIExcludeList"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Note- GET serviceinsertion excludelist API is deprecated. Please use the\npolicy serviceinsertion excludelist API instead.\n","produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Get list of members in exclude list","x-vmw-nsx-module":"ServiceInsertionExcludeList","consumes":["application/json"],"operationId":"GetServiceInsertionExcludeList"}},"/node/services/ssh?action=restart":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the ssh service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","SSH"],"summary":"Restart, start or stop the ssh service","x-vmw-nsx-module":"NodeSSHService","consumes":["application/json"],"operationId":"CreateSSHServiceActionRestart"}},"/node/services/syslog/exporters/{exporter-name}":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeSyslogExporterProperties"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about a specific syslog collection point.","parameters":[{"description":"Name of syslog exporter","required":true,"type":"string","name":"exporter-name","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","Syslog"],"summary":"Read node syslog exporter","x-vmw-nsx-module":"NodeSyslogExporters","consumes":["application/json"],"operationId":"ReadNodeSyslogExporter"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Removes a specified rule from the collection of syslog exporter rules.\n","parameters":[{"description":"Name of syslog exporter to delete","required":true,"type":"string","name":"exporter-name","in":"path"}],"tags":["System Administration","Configuration","Fabric","Nodes","Services","Syslog"],"summary":"Delete node syslog exporter","x-vmw-nsx-module":"NodeSyslogExporters","consumes":["application/json"],"operationId":"DeleteNodeSyslogExporter"}},"/global-configs/{config-type}?action=resync_config":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/GlobalConfigs"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"It is similar to update global configurations but this request would trigger\nupdate even if the configs are unmodified. However, the realization of the\nnew configurations is config-type specific. Refer to config-type\nspecific documentation for details about the configuration push state.\nThis rest routine is deprecated, and will be removed after a year.\n","parameters":[{"required":true,"type":"string","name":"config-type","in":"path"},{"schema":{"$ref":"#/definitions/GlobalConfigs"},"required":true,"name":"GlobalConfigs","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Global Configurations"],"summary":"Resyncs global configurations of a config-type","x-vmw-nsx-module":"GlobalConfigs","consumes":["application/json"],"operationId":"ResyncGlobalConfigs"}},"/configs/central-config/node-config-profiles":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/CentralNodeConfigProfileListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns list of all Central Node Config profiles.\n","produces":["application/json"],"tags":["System Administration","Configuration","Global Configurations"],"summary":"List all Central Node Config profiles","x-vmw-nsx-module":"CentralConfig","consumes":["application/json"],"operationId":"ListCentralNodeConfigProfiles"}},"/directory/domains/{domain-id}/sync-stats":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DirectoryDomainSyncStats"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get domain sync statistics for the given identifier","parameters":[{"description":"Directory domain identifier","required":true,"type":"string","name":"domain-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","Directory Service","Domains"],"summary":"Get domain sync statistics for the given identifier","x-vmw-nsx-module":"DirectoryService","consumes":["application/json"],"operationId":"GetDirectoryDomainSyncStats"}},"/fabric/virtual-machines":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/VirtualMachineListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about all virtual machines.\nIf you have not added NSX tags on the VM or removed\nall the NSX tags that were earlier added to the VM,\nthen tags property is not returned in the API response.\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Display Name of the virtual machine","required":false,"type":"string","name":"display_name","in":"query"},{"description":"VM types to be excluded","required":false,"type":"string","name":"exclude_vm_type","in":"query"},{"description":"External id of the virtual machine","required":false,"type":"string","name":"external_id","in":"query"},{"description":"Id of the host where this vif is located","required":false,"type":"string","name":"host_id","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Policy","Inventory","Virtual Machines"],"summary":"Return the List of Virtual Machines","x-vmw-nsx-module":"Inventory","consumes":["application/json"],"operationId":"ListVirtualMachines"}},"/node/services/search/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read NSX Search service status","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Search Service"],"summary":"Read NSX Search service status","x-vmw-nsx-module":"NodeSearchService","consumes":["application/json"],"operationId":"ReadSearchServiceStatus"}},"/logical-routers/{logical-router-id}/routing/forwarding-table?format=csv":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LogicalRouterRouteTableInCsvFormat"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the FIB table in CSV format for the logical router on a node of the given\ntransport-node-id. Query parameter \"transport_node_id=<transport-node-id>\" is required.\nTo filter the result by network address, paramter \"network_prefix=<a.b.c.d/mask>\"\nneeds to be specified.\nQuery parameter \"source=realtime\" is the only supported source.\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"description":"IPv4 or IPv6 CIDR Block","format":"ip-cidr-block","required":false,"in":"query","type":"string","name":"network_prefix"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"},{"description":"TransportNode Id","required":true,"type":"string","name":"transport_node_id","in":"query"}],"produces":["text/csv"],"tags":["Management Plane API","Networking","Logical Routing And Services","Logical Routers"],"summary":"Get FIB table on a specified node for a logical router","x-vmw-nsx-module":"AggSvcLogicalRouter","consumes":["application/json"],"operationId":"GetLogicalRouterForwardingTableInCsvFormat"}},"/serviceinsertion/sections/{section-id}/rules/{rule-id}?action=revise":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ServiceInsertionRule"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Modifies existing serviceinsertion rule along with relative position among\nother serviceinsertion rules inside a serviceinsertion section.\nNote- POST service insertion rule API is deprecated.\nPlease use policy redirection-policy API.\n","parameters":[{"required":true,"type":"string","name":"section-id","in":"path"},{"required":true,"type":"string","name":"rule-id","in":"path"},{"schema":{"$ref":"#/definitions/ServiceInsertionRule"},"required":true,"name":"ServiceInsertionRule","in":"body"},{"in":"query","description":"Identifier of the anchor rule or section. This is a required field in case operation like 'insert_before' and 'insert_after'.","required":false,"maxLength":64,"type":"string","name":"id"},{"enum":["insert_top","insert_bottom","insert_after","insert_before"],"description":"Operation","default":"insert_top","required":false,"in":"query","type":"string","name":"operation"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Update an Existing Rule and Reorder the Rule","x-vmw-nsx-module":"ServiceInsertionRules","consumes":["application/json"],"operationId":"ReviseServiceInsertionRule"}},"/md-proxies/{proxy-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MetadataProxy"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update a metadata proxy","parameters":[{"required":true,"type":"string","name":"proxy-id","in":"path"},{"schema":{"$ref":"#/definitions/MetadataProxy"},"required":true,"name":"MetadataProxy","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Metadata Proxy"],"summary":"Update a metadata proxy","x-vmw-nsx-module":"MetadataProxy","consumes":["application/json"],"operationId":"UpdateMetadataProxy"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MetadataProxy"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get a metadata proxy","parameters":[{"required":true,"type":"string","name":"proxy-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Metadata Proxy"],"summary":"Get a metadata proxy","x-vmw-nsx-module":"MetadataProxy","consumes":["application/json"],"operationId":"ReadMetadataProxy"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete a metadata proxy","parameters":[{"required":true,"type":"string","name":"proxy-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Metadata Proxy"],"summary":"Delete a metadata proxy","x-vmw-nsx-module":"MetadataProxy","consumes":["application/json"],"operationId":"DeleteMetadataProxy"}},"/fabric/nodes/{node-id}/network/interfaces":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeInterfacePropertiesListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the number of interfaces on the node and detailed\ninformation about each interface. Interface information includes MTU,\nbroadcast and host IP addresses, link and admin status, MAC address, network\nmask, and the IP configuration method (static or DHCP).\nThis api is deprecated. Please use Transport Node API\nGET /transport-nodes/<transport-node-id>/network/interfaces\nto list node network interfaces for the corresponding TN.\n","parameters":[{"required":true,"type":"string","name":"node-id","in":"path"},{"description":"Admin status of the interface","enum":["UP","DOWN"],"type":"string","name":"admin_status","in":"query"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Transport Node Interfaces"],"summary":"List the specified node's Network Interfaces","x-vmw-nsx-module":"ApplianceStats","consumes":["application/json"],"operationId":"ListFabricNodeInterfaces"}},"/fabric/discovered-nodes/{node-ext-id}":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DiscoveredNode"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about a specific discovered node.","parameters":[{"required":true,"type":"string","name":"node-ext-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Discovered Nodes"],"summary":"Return Discovered Node Information","x-vmw-nsx-module":"InventoryCmObj","consumes":["application/json"],"operationId":"ReadDiscoveredNode"}},"/edge-clusters/{edge-cluster-id}/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EdgeClusterStatus"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the aggregated status for the Edge cluster along with status of\nall edge nodes in the cluster. Query parameter \"source=realtime\" is the\nonly supported source.\n","parameters":[{"required":true,"type":"string","name":"edge-cluster-id","in":"path"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Edge Clusters","Edge Clusters"],"summary":"Get the status for the Edge cluster of the given id","x-vmw-nsx-module":"AggSvcEdgeCluster","consumes":["application/json"],"operationId":"GetEdgeClusterStatus"}},"/node/services/messaging-manager?action=restart":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the NSX Messaging Manager service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Messaging Manager Service"],"summary":"Restart, start or stop the NSX Messaging Manager service","x-vmw-nsx-module":"NodeNSXMessagingManagerService","consumes":["application/json"],"operationId":"CreateNSXMessagingManagerServiceActionRestart"}},"/dns/forwarders/{forwarder-id}?action=disable":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Disable the DNS forwarder if the forwarder is currently enbled. If the DNS\nforwarder is already disabled, the forwarder will not be re-disabled.\n\nPlease note, once a DNS forwarder is disabled then enabled, the previous\nDNS forwarder statistics counters will be reset.\n","parameters":[{"required":true,"type":"string","name":"forwarder-id","in":"path"}],"tags":["Management Plane API","Networking","Services","DNS"],"summary":"Disable the DNS forwarder.","x-vmw-nsx-module":"DnsForwarder","consumes":["application/json"],"operationId":"DisableDnsForwarder"}},"/aaa/roles?action=validate":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RecommendedFeaturePermissionListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Validate the permissions of an incoming role. Also, recommend the\npermissions which need to be corrected.\n","parameters":[{"schema":{"$ref":"#/definitions/FeaturePermissionArray"},"required":true,"name":"FeaturePermissionArray","in":"body"}],"produces":["application/json"],"tags":["System Administration","Settings","User Management","Roles"],"summary":"Validate a new feature permission set","x-vmw-nsx-module":"AAA","consumes":["application/json"],"operationId":"ValidateAndRecommendPermissions"}},"/migration/migration-unit-groups/{group-id}?action=add_migration_units":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MigrationUnitList"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Add migration units to specified migration unit group. The migration\nunits will be added at the end of the migration unit list.\n","parameters":[{"required":true,"type":"string","name":"group-id","in":"path"},{"schema":{"$ref":"#/definitions/MigrationUnitList"},"required":true,"name":"MigrationUnitList","in":"body"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Migration","Group"],"summary":"Add migration units to specified migration unit group","x-vmw-nsx-module":"Migration","consumes":["application/json"],"operationId":"AddMigrationUnitsToGroup"}},"/dhcp/servers/{server-id}/static-bindings/{binding-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DhcpStaticBinding"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update a specific static binding of a given local DHCP server.","parameters":[{"required":true,"type":"string","name":"server-id","in":"path"},{"required":true,"type":"string","name":"binding-id","in":"path"},{"schema":{"$ref":"#/definitions/DhcpStaticBinding"},"required":true,"name":"DhcpStaticBinding","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","DHCP"],"summary":"Update a DHCP server's static binding","x-vmw-nsx-module":"Dhcp","consumes":["application/json"],"operationId":"UpdateDhcpStaticBinding"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete a specific static binding of a given logical DHCP server.","parameters":[{"required":true,"type":"string","name":"server-id","in":"path"},{"required":true,"type":"string","name":"binding-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","DHCP"],"summary":"Delete a static binding","x-vmw-nsx-module":"Dhcp","consumes":["application/json"],"operationId":"DeleteDhcpStaticBinding"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DhcpStaticBinding"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Return a specific static binding of a given logical DHCP server.\n","parameters":[{"required":true,"type":"string","name":"server-id","in":"path"},{"required":true,"type":"string","name":"binding-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","DHCP"],"summary":"Get a DHCP server's static binding with the specified binding ID","x-vmw-nsx-module":"Dhcp","consumes":["application/json"],"operationId":"ReadDhcpStaticBinding"}},"/serviceinsertion/services/{service-id}/vendor-templates":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/VendorTemplate"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Adds a new vendor template. Vendor templates are service level objects,\nregistered to be used in Service Profiles.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"schema":{"$ref":"#/definitions/VendorTemplate"},"required":true,"name":"VendorTemplate","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Add Vendor Template for a given Service","x-vmw-nsx-module":"ServiceInsertion","consumes":["application/json"],"operationId":"AddVendorTemplate"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/VendorTemplateListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"List all vendor templates of a service.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"description":"Name of vendor template","required":false,"type":"string","name":"vendor_template_name","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"List all VendorTemplates of a Service.","x-vmw-nsx-module":"ServiceInsertion","consumes":["application/json"],"operationId":"ListVendorTemplates"}},"/logical-routers/{logical-router-id}/routing/routing-table":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LogicalRouterRouteTable"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the route table(RIB) for the logical router on a node of the given transport-node-id.\nQuery parameter \"transport_node_id=<transport-node-id>\" is required.\nTo filter the result by network address, parameter \"network_prefix=<a.b.c.d/mask>\"\nneeds to be specified.\nTo filter the result by route source, parameter \"route_source=<source_type>\" needs to be specified\nwhere source_type can be BGP, STATIC, CONNECTED, NSX_STATIC, TIER1_NAT or TIER0_NAT.\nIt is also possible to filter the RIB table using both network address and\nroute source filter together.\nQuery parameter \"source=realtime\" is the only supported source.\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"IPAddress or CIDR Block","format":"address-or-cidr-block","required":false,"in":"query","type":"string","name":"network_prefix"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"description":"Route source filter parameter","enum":["BGP","STATIC","CONNECTED","OSPF"],"type":"string","name":"route_source","in":"query"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"},{"description":"TransportNode Id","required":true,"type":"string","name":"transport_node_id","in":"query"},{"enum":["DEFAULT","INTER_SR"],"description":"VRF filter parameter","required":false,"in":"query","type":"string","name":"vrf_table"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Logical Routers"],"summary":"Get RIB table on a specified node for a logical router","x-vmw-nsx-module":"AggSvcLogicalRouter","consumes":["application/json"],"operationId":"GetLogicalRouterRoutingTable"}},"/node/services/snmp?action=start":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the SNMP service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","SNMP"],"summary":"Restart, start or stop the SNMP service","x-vmw-nsx-module":"NodeSNMPService","consumes":["application/json"],"operationId":"CreateSNMPServiceActionStart"}},"/firewall/profiles/{profile-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BaseFirewallProfile"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update user configurable properties of firewall profile.\n","parameters":[{"required":true,"type":"string","name":"profile-id","in":"path"},{"schema":{"$ref":"#/definitions/BaseFirewallProfile"},"required":true,"name":"BaseFirewallProfile","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Firewall"],"summary":"Update a firewall profile.","x-vmw-nsx-module":"FirewallProfile","consumes":["application/json"],"operationId":"UpdateFirewallProfile"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Deletes a firewall profile.\n","parameters":[{"required":true,"type":"string","name":"profile-id","in":"path"}],"tags":["Management Plane API","Security","Services","Firewall"],"summary":"Delete a firewall profile.","x-vmw-nsx-module":"FirewallProfile","consumes":["application/json"],"operationId":"DeleteFirewallProfile"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BaseFirewallProfile"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Return firewall session timer profile.\n","parameters":[{"required":true,"type":"string","name":"profile-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Firewall"],"summary":"Get all firewall session timer profiles.","x-vmw-nsx-module":"FirewallProfile","consumes":["application/json"],"operationId":"GetFirewallProfile"}},"/edge-clusters/{edge-cluster-id}/inter-site/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EdgeClusterInterSiteStatus"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the aggregated status for the Edge cluster along with status of\nall edge nodes in the cluster. It always returns cached response.\n","parameters":[{"required":true,"type":"string","name":"edge-cluster-id","in":"path"}],"produces":["application/json"],"tags":["Federation","Inter-Sites"],"summary":"Get inter-site status of the edge cluster","x-vmw-nsx-module":"AggSvcEdgeCluster","consumes":["application/json"],"operationId":"GetEdgeClusterInterSiteStatus"}},"/vpn/ipsec/sessions/{session-id}/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IPSecVPNSessionStatus"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"List status of IPSec session. Query parameter source supports both realtime and cached mode.","parameters":[{"required":true,"type":"string","name":"session-id","in":"path"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"}],"produces":["application/json"],"tags":["Management Plane API","Networking","VPN","Statistics","IKE Sessions Status"],"summary":"Get IPSec VPN IKE session status","x-vmw-nsx-module":"VPNStatistics","consumes":["application/json"],"operationId":"GetIPSecVPNIKESessionStatus"}},"/node/services/snmp?action=restart":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the SNMP service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","SNMP"],"summary":"Restart, start or stop the SNMP service","x-vmw-nsx-module":"NodeSNMPService","consumes":["application/json"],"operationId":"CreateSNMPServiceActionRestart"}},"/upgrade/bundles/{bundle-id}?action=cancel_upload":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"description":"Internal Server Error"}},"description":"Cancel upload of upgrade bundle. This API works only when bundle upload is\nin-progress and will not work during post-processing of upgrade bundle. If\nbundle upload is in-progress, then the API call returns http OK response\nafter cancelling the upload and deleting partially uploaded bundle.\n","parameters":[{"required":true,"type":"string","name":"bundle-id","in":"path"}],"tags":["System Administration","Lifecycle Management","Upgrade","Bundles"],"summary":"Cancel upgrade bundle upload","x-vmw-nsx-module":"Upgrade","consumes":["application/json"],"operationId":"CancelUpgradeBundleUpload"}},"/fabric/container-applications/{container-application-id}":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ContainerApplication"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about a specific Container Application within a project.","parameters":[{"required":true,"type":"string","name":"container-application-id","in":"path"}],"produces":["application/json"],"tags":["Policy","Inventory","Containers","Container Applications"],"summary":"Return a Container Application within a container project","x-vmw-nsx-module":"InventoryContainerObj","consumes":["application/json"],"operationId":"GetContainerApplication"}},"/serviceinsertion/sections/{section-id}/rules/{rule-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ServiceInsertionRule"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Modifies existing serviceinsertion rule in a serviceinsertion section.\nNote- PUT service insertion rule API is deprecated.\nPlease use policy redirection-policy API.\n","parameters":[{"required":true,"type":"string","name":"section-id","in":"path"},{"required":true,"type":"string","name":"rule-id","in":"path"},{"schema":{"$ref":"#/definitions/ServiceInsertionRule"},"required":true,"name":"ServiceInsertionRule","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Update an Existing Rule","x-vmw-nsx-module":"ServiceInsertionRules","consumes":["application/json"],"operationId":"UpdateServiceInsertionRule"},"delete":{"responses":{"200":{"description":"OK"},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete existing serviceinsertion rule in a serviceinsertion section.\nNote- DELETE service insertion rule API is deprecated.\nPlease use policy redirection-policy API.\n","parameters":[{"required":true,"type":"string","name":"section-id","in":"path"},{"required":true,"type":"string","name":"rule-id","in":"path"}],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Delete an Existing Rule","x-vmw-nsx-module":"ServiceInsertionRules","consumes":["application/json"],"operationId":"DeleteServiceInsertionRule"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ServiceInsertionRule"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Return existing serviceinsertion rule information in a serviceinsertion section.\nNote- GET service insertion rule API is deprecated.\nPlease use policy redirection-policy API.\n","parameters":[{"required":true,"type":"string","name":"section-id","in":"path"},{"required":true,"type":"string","name":"rule-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Read an Existing Rule","x-vmw-nsx-module":"ServiceInsertionRules","consumes":["application/json"],"operationId":"GetServiceInsertionRule"}},"/node/services/controller?action=start":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the controller service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Controller Service"],"summary":"Restart, start or stop the controller service","x-vmw-nsx-module":"NodeControllerServerService","consumes":["application/json"],"operationId":"CreateControllerServerServiceActionStart"}},"/node/services/ssh?action=remove_host_fingerprint":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Remove a host's fingerprint from known hosts file","parameters":[{"schema":{"$ref":"#/definitions/KnownHostParameter"},"required":true,"name":"KnownHostParameter","in":"body"}],"tags":["System Administration","Configuration","Fabric","Nodes","Services","SSH"],"summary":"Remove a host's fingerprint from known hosts file","x-vmw-nsx-module":"NodeSSHService","consumes":["application/json"],"operationId":"CreateSSHServiceRemoveHostFingerprintActionRemoveHostFingerprint"}},"/directory/domains/{domain-id}/groups":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DirectoryGroupListResults"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Search for directory groups within a domain based on the substring of a distinguished name. (e.g. CN=User,DC=acme,DC=com) The search filter pattern can optionally support multiple (up to 100 maximum) search pattern separated by '|' (url encoded %7C). In this case, the search results will be returned as the union of all matching criteria. (e.g. CN=Ann,CN=Users,DC=acme,DC=com|CN=Bob,CN=Users,DC=acme,DC=com)","parameters":[{"description":"Directory domain identifier","required":true,"type":"string","name":"domain-id","in":"path"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Name search filter value","required":true,"type":"string","name":"filter_value","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["System Administration","Configuration","Directory Service","Groups"],"summary":"Search for directory groups within a domain based on the substring of a distinguished name. (e.g. CN=User,DC=acme,DC=com) The search filter pattern can optionally support multiple (up to 100 maximum) search pattern separated by '|' (url encoded %7C). In this case, the search results will be returned as the union of all matching criteria. (e.g. CN=Ann,CN=Users,DC=acme,DC=com|CN=Bob,CN=Users,DC=acme,DC=com)","x-vmw-nsx-module":"DirectoryService","consumes":["application/json"],"operationId":"SearchDirectoryGroups"}},"/idfw/compute-collections/{cc-ext-id}/transport-nodes/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IdfwTransportNodeStatusListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Retrieve all the transport node and status by idfw enabled\n ComputeCollection ID in the request.\n","parameters":[{"required":true,"type":"string","name":"cc-ext-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Security","Identity Firewall","Monitoring"],"summary":"List all transport node and statuses based on idfw enabled ComputeCollection ID.","x-vmw-nsx-module":"IdentityFirewall","consumes":["application/json"],"operationId":"ListTransportNodeStatusesByComputeCollectionId"}},"/transport-nodes/{node-id}/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TransportNodeStatus"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read status of a transport node","parameters":[{"description":"ID of transport node","required":true,"type":"string","name":"node-id","in":"path"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Transport Node Status"],"summary":"Read status of a transport node","x-vmw-nsx-module":"Heatmap","consumes":["application/json"],"operationId":"GetTransportNodeStatus"}},"/idfw/compute-collections/{compute-collection-ext-id}/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IdfwComputeCollectionStatus"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Retrieve the compute collection status by ID.\n","parameters":[{"required":true,"type":"string","name":"compute-collection-ext-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Security","Identity Firewall","Monitoring"],"summary":"Get list of compute collections and status.","x-vmw-nsx-module":"IdentityFirewall","consumes":["application/json"],"operationId":"GetComputeCollectionStatusById"}},"/node/services/ui-service?action=stop":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, Start and Stop the ui service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","User Interface Service"],"summary":"Restart, Start and Stop the ui service","x-vmw-nsx-module":"NodeUiServiceService","consumes":["application/json"],"operationId":"CreateNsxUiServiceServiceActionStop"}},"/pools/ip-blocks":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/IpBlock"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Creates a new IPv4 address block using the specified cidr. cidr is a required\nparameter. display_name & description are optional parameters\n","parameters":[{"schema":{"$ref":"#/definitions/IpBlock"},"required":true,"name":"IpBlock","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Pool Management","IP Blocks"],"summary":"Create a new IP address block.","x-vmw-nsx-module":"Ipam","consumes":["application/json"],"operationId":"CreateIpBlock"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IpBlockListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about configured IP address blocks. Information includes\nthe id, display name, description & CIDR of IP address blocks\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Pool Management","IP Blocks"],"summary":"Returns list of configured IP address blocks.","x-vmw-nsx-module":"Ipam","consumes":["application/json"],"operationId":"ListIpBlocks"}},"/migration/mp-policy-promotion/state":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MPPolicyPromotionState"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"This api is used to get promotion state.\n","produces":["application/json"],"tags":["System Administration","Lifecycle Management","Migration","Plan"],"summary":"This api is used to get mp policy promotion state.\n","x-vmw-nsx-module":"MPPolicyMigration","consumes":["application/json"],"operationId":"GetMPPolicyPromotionState"}},"/loadbalancer/services/{service-id}/virtual-servers/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LbVirtualServerStatusListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the status list of virtual servers in given load balancer service.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Get the status list of virtual servers in given load balancer service","x-vmw-nsx-module":"AggSvcLb","consumes":["application/json"],"operationId":"ListLoadBalancerVirtualServerStatuses"}},"/capacity/threshold":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/CapacityThresholdList"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Updates the warning threshold(s) for NSX Objects specified, and returns\nnew threshold(s). Threshold list in the request must contain value for GLOBAL_DEFAULT\nthreshold_type which represents global thresholds.\n","parameters":[{"schema":{"$ref":"#/definitions/CapacityThresholdList"},"required":true,"name":"CapacityThresholdList","in":"body"}],"produces":["application/json"],"tags":["System Administration","Monitoring","Dashboards","Capacity Dashboard"],"summary":"Updates the warning threshold(s) for NSX Objects.","x-vmw-nsx-module":"ProtonCapacityDashboard","consumes":["application/json"],"operationId":"UpdateProtonCapacityThresholds"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/CapacityThresholdList"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns warning threshold(s) set for NSX Objects.","produces":["application/json"],"tags":["System Administration","Monitoring","Dashboards","Capacity Dashboard"],"summary":"Returns warning threshold(s) set for NSX Objects.","x-vmw-nsx-module":"ProtonCapacityDashboard","consumes":["application/json"],"operationId":"GetProtonCapacityThresholds"}},"/dhcp/server-profiles/{profile-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DhcpProfile"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"If both the edge_cluster_member_indexes in the DhcpProfile are changed in\na same PUT API, e.g. change from [a,b] to [x,y], the current DHCP server\nleases will be lost, which could cause the network crash due to ip conflicts.\nHence the suggestion is to change only one member index in one single update,\ne.g. from [a, b] to [a,y].\n\nPlease note, the edge_cluster_id in DhcpProfile can NOT be changed by this\nPUT operation because all existing DHCP leases will lost. If losing leases\nis not a problem, a dedicated re-allocation API is suggested to modify the\nedge-cluster-id, i.e. \"POST /api/v1/dhcp/dhcp-profiles/<profileiid>?action=reallocate\".\n\nMeanwhile, if the edge_cluster_member_indexes was specified currently but\nnow is changed to none (not specified) via a PUT operation, the edge nodes\nwill not be auto-selected from edge cluster. Instead, the previously-allocated\nedge nodes will continue to be used by the DHCP server. This is because\nchanging both edge nodes of a DHCP server will lose all existing leases.\nIn case re-allocation is required and leases lost is not a problem (or can\nbe recovered), please invoke the reallocate API mentioned above with new\nDhcpProfile to accomplish the intent.\n","parameters":[{"required":true,"type":"string","name":"profile-id","in":"path"},{"schema":{"$ref":"#/definitions/DhcpProfile"},"required":true,"name":"DhcpProfile","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","DHCP"],"summary":"Update a DHCP server profile","x-vmw-nsx-module":"Dhcp","consumes":["application/json"],"operationId":"UpdateDhcpProfile"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DhcpProfile"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Return the DHCP profile specified by the profile id.","parameters":[{"required":true,"type":"string","name":"profile-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","DHCP"],"summary":"Get a DHCP server profile","x-vmw-nsx-module":"Dhcp","consumes":["application/json"],"operationId":"ReadDhcpProfile"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete a DHCP server profile specified by the profile id.","parameters":[{"required":true,"type":"string","name":"profile-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","DHCP"],"summary":"Delete a DHCP server profile","x-vmw-nsx-module":"Dhcp","consumes":["application/json"],"operationId":"DeleteDhcpProfile"}},"/alarms/{alarm-id}":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Alarm"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns alarm associated with alarm-id. If HTTP status 404 is returned,\nthis means the specified alarm-id is invalid or the alarm with alarm-id\nhas been deleted. An alarm is deleted by the system if it is RESOLVED\nand older than eight days. The system can also delete the remaining\nRESOLVED alarms sooner to free system resources when too many alarms\nare being generated. When this happens the oldest day's RESOLVED alarms\nare deleted first.\n","parameters":[{"required":true,"type":"string","name":"alarm-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Monitoring","Alarms And Events"],"summary":"Get Alarm identified by alarm-id.","x-vmw-nsx-module":"Monitoring","consumes":["application/json"],"operationId":"GetAlarm"}},"/node/services/liagent/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read liagent service status","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","Log Insight"],"summary":"Read liagent service status","x-vmw-nsx-module":"NodeLiagentService","consumes":["application/json"],"operationId":"ReadLiagentServiceStatus"}},"/upgrade/upgrade-unit-groups/{group-id}?action=add_upgrade_units":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UpgradeUnitList"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Add upgrade units to specified upgrade unit group. The upgrade\nunits will be added at the end of the upgrade unit list.\n","parameters":[{"required":true,"type":"string","name":"group-id","in":"path"},{"schema":{"$ref":"#/definitions/UpgradeUnitList"},"required":true,"name":"UpgradeUnitList","in":"body"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Upgrade","Group"],"summary":"Add upgrade units to specified upgrade unit group","x-vmw-nsx-module":"Upgrade","consumes":["application/json"],"operationId":"AddUpgradeUnitsToGroup"}},"/vpn/ipsec/sessions/{ipsec-vpn-session-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IPSecVPNSession"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Edit IPSec VPN session.","parameters":[{"required":true,"type":"string","name":"ipsec-vpn-session-id","in":"path"},{"schema":{"$ref":"#/definitions/IPSecVPNSession"},"required":true,"name":"IPSecVPNSession","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","VPN","IPSEC","Sessions"],"summary":"Edit IPSec VPN session","x-vmw-nsx-module":"IPSecVPN","consumes":["application/json"],"operationId":"UpdateIPSecVPNSession"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete IPSec VPN session.","parameters":[{"required":true,"type":"string","name":"ipsec-vpn-session-id","in":"path"},{"default":false,"description":"Force delete the resource even if it is being used somewhere\n","type":"boolean","name":"force","in":"query"}],"tags":["Management Plane API","Networking","VPN","IPSEC","Sessions"],"summary":"Delete IPSec VPN session","x-vmw-nsx-module":"IPSecVPN","consumes":["application/json"],"operationId":"DeleteIPSecVPNSession"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IPSecVPNSession"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Fetch IPSec VPN session.","parameters":[{"required":true,"type":"string","name":"ipsec-vpn-session-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","VPN","IPSEC","Sessions"],"summary":"Fetch IPSec VPN session","x-vmw-nsx-module":"IPSecVPN","consumes":["application/json"],"operationId":"GetIPSecVPNSession"}},"/loadbalancer/usage-per-node/{node-id}":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LbNodeUsage"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"API is used to retrieve the usage of load balancer entities which include\ncurrent number and remaining number of credits, virtual Servers, pools,\npool Members and different size of LB services from the given node.\nCurrently only Edge node is supported.\n","parameters":[{"required":true,"type":"string","name":"node-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Read load balancer usage for the given node","x-vmw-nsx-module":"LoadBalancer","consumes":["application/json"],"operationId":"ReadLoadBalancerNodeUsage"}},"/fabric/compute-managers":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/ComputeManager"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"description":"Bad Request"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Registers compute manager with NSX. Inventory service will collect\ndata from the registered compute manager\n","parameters":[{"schema":{"$ref":"#/definitions/ComputeManager"},"required":true,"name":"ComputeManager","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Compute Managers"],"summary":"Register compute manager with NSX","x-vmw-nsx-module":"InventoryCmObj","consumes":["application/json"],"operationId":"AddComputeManager"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ComputeManagerListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about all compute managers.","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Compute manager type like vCenter","required":false,"type":"string","name":"origin_type","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"description":"IP address or hostname of compute manager","format":"hostname-or-ip","required":false,"in":"query","type":"string","name":"server"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Compute Managers"],"summary":"Return the List of Compute managers","x-vmw-nsx-module":"InventoryCmObj","consumes":["application/json"],"operationId":"ListComputeManagers"}},"/loadbalancer/ssl/ciphers-and-protocols":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LbSslCipherAndProtocolListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Retrieve a list of supported SSL ciphers and protocols.\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Retrieve a list of supported SSL ciphers and protocols","x-vmw-nsx-module":"LoadBalancer","consumes":["application/json"],"operationId":"ListLoadBalancerSslCiphersAndProtocols"}},"/transport-nodes/{node-id}?action=redeploy":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TransportNode"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Redeploys an edge node at NSX Manager that replaces the edge node with\nidentifier <node-id>. If NSX Manager can access the specified edge node,\nthen the node is put into maintenance mode and then the associated VM is\ndeleted. This is a means to reset all configuration on the edge node.\nThe communication channel between NSX Manager and edge is established after\nthis operation.\n","parameters":[{"required":true,"type":"string","name":"node-id","in":"path"},{"schema":{"$ref":"#/definitions/TransportNode"},"required":true,"name":"TransportNode","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Transport Nodes"],"summary":"Redeploys a new node that replaces the specified edge node.","x-vmw-nsx-module":"TransportNodeLcm","consumes":["application/json"],"operationId":"RedeployEdgeTransportNode"}},"/loadbalancer/services/{service-id}/debug-info":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LbServiceDebugInfo"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"API to download below information which will be used for debugging and\ntroubleshooting.\n1) Load balancer service\n2) Load balancer associated virtual servers\n3) Load balancer associated pools\n4) Load balancer associated profiles such as persistence, SSL, application.\n5) Load balancer associated monitors\n6) Load balancer associated rules\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Read the debug information of the load balancer service","x-vmw-nsx-module":"LoadBalancer","consumes":["application/json"],"operationId":"ReadLoadBalancerServiceDebugInfo"}},"/migration/migration-unit-groups/{group-id}/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MigrationUnitStatusListResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get migration status for migration units in the specified group. User can\nspecify whether to show only the migration units with errors.\n","parameters":[{"required":true,"type":"string","name":"group-id","in":"path"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Flag to indicate whether to return only migration units with errors","default":false,"required":false,"in":"query","type":"boolean","name":"has_errors"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Migration","Group"],"summary":"Get migration status for group","x-vmw-nsx-module":"Migration","consumes":["application/json"],"operationId":"GetMigrationUnitGroupStatus"}},"/transport-nodes/{transport-node-id}?action=enable_flow_cache":{"post":{"responses":{"200":{"description":"OK"},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Enable flow cache for edge transport node.\nCaution: This involves restart of the edge\ndataplane and hence may lead to network disruption.\n","parameters":[{"required":true,"type":"string","name":"transport-node-id","in":"path"}],"tags":["System Administration","Configuration","Fabric","Nodes","Transport Nodes"],"summary":"Enable flow cache for an edge transport node","x-vmw-nsx-module":"TransportNodeLcm","consumes":["application/json"],"operationId":"EnableFlowCache"}},"/aaa/vidm/users":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/VidmInfoListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"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. This API will return as many results that vIDM returns to NSX during the search query. vIDM may not send all results at once so to zero in on the user of interest more characters need to be entered.","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"description":"Search string to search for.\n","required":true,"type":"string","name":"search_string","in":"query"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["System Administration","Settings","User Management","VIDM Configuration"],"summary":"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. This API will return as many results that vIDM returns to NSX during the search query. vIDM may not send all results at once so to zero in on the user of interest more characters need to be entered.","x-vmw-nsx-module":"AAA","consumes":["application/json"],"operationId":"GetUserVidmSearchResult"}},"/migration/mp-to-policy/stats":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MigrationStatsResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"To get MP2Policy promotion stats.\nThis gives detailed information about promotion progess per resource type\nlike what's the promotion status, how many resources has been promoted etc.\n","parameters":[{"enum":["CURRENT","ARCHIVED"],"description":"Location flag","default":"CURRENT","required":false,"in":"query","type":"string","name":"location"},{"description":"Flag to indicate whether to get collection stats before triggering promotion","default":false,"required":false,"in":"query","type":"boolean","name":"pre_promotion"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Migration","Plan"],"summary":"To get MP2Policy promotion stats.","x-vmw-nsx-module":"MPPolicyMigration","consumes":["application/json"],"operationId":"Mp2PolicyMigrationStats"}},"/host-switch-profiles":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/BaseHostSwitchProfile"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Creates a hostswitch profile. The resource_type is required. For uplink\nprofiles, the teaming and policy parameters are required. By default, the\nmtu is 1600 and the transport_vlan is 0. The supported MTU range is 1280\nthrough (uplink_mtu_threshold). (uplink_mtu_threshold) is 9000 by default.\nRange can be extended by modifying (uplink_mtu_threshold) in\nSwitchingGlobalConfig to the required upper threshold.\nThis api is now deprecated. Please use new api -\nPUT policy/api/v1/infra/host-switch-profiles/uplinkProfile1\n","parameters":[{"schema":{"$ref":"#/definitions/BaseHostSwitchProfile"},"required":true,"name":"BaseHostSwitchProfile","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Profiles","Hostswitch Profiles"],"summary":"Create a Hostswitch Profile","x-vmw-nsx-module":"BaseHostSwitchProfile","consumes":["application/json"],"operationId":"CreateHostSwitchProfile"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/HostSwitchProfilesListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about the configured hostswitch profiles. Hostswitch\nprofiles define networking policies for hostswitches (sometimes referred to\nas bridges in OVS). Currently, only uplink teaming is supported. Uplink\nteaming allows NSX to load balance traffic across different physical NICs\n(PNICs) on the hypervisor hosts. Multiple teaming policies are supported,\nincluding LACP active, LACP passive, load balancing based on source ID, and\nfailover order. This api is now deprecated. Please use new api -\npolicy/api/v1/infra/host-switch-profiles\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"enum":["VIRTUAL_MACHINE","PHYSICAL_MACHINE","UNKNOWN"],"description":"Supported edge deployment type.","required":false,"in":"query","type":"string","name":"deployment_type"},{"enum":["UplinkHostSwitchProfile","LldpHostSwitchProfile","NiocProfile","ExtraConfigHostSwitchProfile"],"description":"Supported HostSwitch profiles.","required":false,"in":"query","type":"string","name":"hostswitch_profile_type"},{"description":"Whether the list result contains system resources","default":false,"required":false,"in":"query","type":"boolean","name":"include_system_owned"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"enum":["EdgeNode","PublicCloudGatewayNode"],"description":"Fabric node type for which uplink profiles are to be listed","required":false,"in":"query","type":"string","name":"node_type"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"description":"The host switch profile's uplink teaming policy name","required":false,"type":"string","name":"uplink_teaming_policy_name","in":"query"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Profiles","Hostswitch Profiles"],"summary":"List Hostswitch Profiles","x-vmw-nsx-module":"BaseHostSwitchProfile","consumes":["application/json"],"operationId":"ListHostSwitchProfiles"}},"/ipv6/dad-profiles/{dad-profile-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DADProfile"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update DADProfile.\n","parameters":[{"required":true,"type":"string","name":"dad-profile-id","in":"path"},{"schema":{"$ref":"#/definitions/DADProfile"},"required":true,"name":"DADProfile","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Routing Configuration"],"summary":"Update DADProfile","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"UpdateDADProfile"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DADProfile"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about specified IPv6 DADProfile.\n","parameters":[{"required":true,"type":"string","name":"dad-profile-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Routing Configuration"],"summary":"Read specified IPV6 DADProfile","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"ReadDADProfile"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete DADProfile\n","parameters":[{"required":true,"type":"string","name":"dad-profile-id","in":"path"}],"tags":["Management Plane API","Networking","Logical Routing And Services","Routing Configuration"],"summary":"Delete DAD Profile","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"DeleteDADProfile"}},"/serviceinsertion/services/{service-id}/solution-configs/{solution-config-id}/extended-solution-config":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ExtendedSolutionConfig"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Updates a extended solution config. Extended Solution Config are service level objects,\nused by the NXGI partner Service inside the SVM.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"required":true,"type":"string","name":"solution-config-id","in":"path"},{"schema":{"$ref":"#/definitions/ExtendedSolutionConfig"},"required":true,"name":"ExtendedSolutionConfig","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Updates extended solution Config for a given Service","x-vmw-nsx-module":"Nxgi","consumes":["application/json"],"operationId":"UpdateExtendedSolutionConfig"},"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ExtendedSolutionConfig"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Adds a extended solution config. Extended Solution Config are service level objects,\nused by the NXGI partner Service inside the SVM.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"required":true,"type":"string","name":"solution-config-id","in":"path"},{"schema":{"$ref":"#/definitions/ExtendedSolutionConfig"},"required":true,"name":"ExtendedSolutionConfig","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Add Extended solution Config for a given Service","x-vmw-nsx-module":"Nxgi","consumes":["application/json"],"operationId":"CreateExtendedSolutionConfig"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ExtendedSolutionConfig"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns extended solution config information for a given solution config id.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"required":true,"type":"string","name":"solution-config-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Get extended solution Config Information for a given solution config id.","x-vmw-nsx-module":"Nxgi","consumes":["application/json"],"operationId":"GetExtendedSolutionConfig"},"delete":{"responses":{"200":{"description":"OK"},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Deletes extended solution config information for a given solution config id.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"required":true,"type":"string","name":"solution-config-id","in":"path"}],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Deletes extended solution config information.","x-vmw-nsx-module":"Nxgi","consumes":["application/json"],"operationId":"DeleteExtendedSolutionConfig"}},"/cluster/nodes/{node-id}/network/interfaces/{interface-id}":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeInterfaceProperties"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns detailed information about the specified interface. Interface\ninformation includes MTU, broadcast and host IP addresses, link and admin\nstatus, MAC address, network mask, and the IP configuration method (static\nor DHCP).\n","parameters":[{"required":true,"type":"string","name":"node-id","in":"path"},{"required":true,"type":"string","name":"interface-id","in":"path"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"}],"produces":["application/json"],"tags":["System Administration","Configuration","NSX Managers","Clusters","Cluster Interfaces"],"summary":"Read the node's Network Interface","x-vmw-nsx-module":"ApplianceStats","consumes":["application/json"],"operationId":"ReadClusterNodeInterface"}},"/logical-router-ports/{logical-router-port-id}/statistics/summary":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LogicalRouterPortStatisticsSummary"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the summation of statistics from all nodes for the Specified\nLogical Router Port.\nThe query parameter \"source=realtime\" is not supported.\n","parameters":[{"required":true,"type":"string","name":"logical-router-port-id","in":"path"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Logical Router Ports"],"summary":"Get the statistics summary of a specified logical router port","x-vmw-nsx-module":"AggSvcLogicalRouterPort","consumes":["application/json"],"operationId":"GetLogicalRouterPortStatisticsSummary"}},"/pktcap/session/{session-id}":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PacketCaptureSession"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get the packet capture status information by session id.\n","parameters":[{"description":"Packet capture session id","required":true,"type":"string","name":"session-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Troubleshooting And Monitoring","Packet Capture"],"summary":"Get the status of packet capture session","x-vmw-nsx-module":"PacketCapture","consumes":["application/json"],"operationId":"ReadPacketCaptureSession"}},"/fabric/container-projects":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ContainerProjectListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about all container projects","parameters":[{"description":"Identifier of the container cluster","required":false,"type":"string","name":"container_cluster_id","in":"query"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"description":"Scope id for container cluster","required":false,"type":"string","name":"scope_id","in":"query"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Policy","Inventory","Containers","Container Projects"],"summary":"Return the list of container projects","x-vmw-nsx-module":"InventoryContainerObj","consumes":["application/json"],"operationId":"ListContainerProjects"}},"/cluster/backups?action=retrieve_ssh_fingerprint":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RemoteServerFingerprint"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get SHA256 fingerprint of ECDSA key of remote server. The caller should\nindependently verify that the key is trusted.\n","parameters":[{"schema":{"$ref":"#/definitions/RemoteServerFingerprintRequest"},"required":true,"name":"RemoteServerFingerprintRequest","in":"body"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Backup Restore Management","Backup"],"summary":"Get ssh fingerprint of remote(backup) server","x-vmw-nsx-module":"BackupConfiguration","consumes":["application/json"],"operationId":"GetSshFingerprintOfServer"}},"/logical-router-ports":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/LogicalRouterPort"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Creates a logical router port. The required parameters include resource_type\n(LogicalRouterUpLinkPort, LogicalRouterDownLinkPort, LogicalRouterLinkPort,\nLogicalRouterLoopbackPort, LogicalRouterCentralizedServicePort); and\nlogical_router_id (the router to which each logical router port is assigned).\nThe service_bindings parameter is optional.\n","parameters":[{"schema":{"$ref":"#/definitions/LogicalRouterPort"},"required":true,"name":"LogicalRouterPort","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Logical Router Ports"],"summary":"Create a Logical Router Port","x-vmw-nsx-module":"LogicalRouterPorts","consumes":["application/json"],"operationId":"CreateLogicalRouterPort"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LogicalRouterPortListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about all logical router ports. Information includes the\nresource_type (LogicalRouterUpLinkPort, LogicalRouterDownLinkPort,\nLogicalRouterLinkPort, LogicalRouterLoopbackPort, LogicalRouterCentralizedServicePort);\nlogical_router_id (the router to which each logical router port is assigned);\nand any service_bindings (such as DHCP relay service).\nThe GET request can include a query parameter (logical_router_id\nor logical_switch_id).\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Logical Router identifier","required":false,"type":"string","name":"logical_router_id","in":"query"},{"description":"Logical Switch identifier","required":false,"type":"string","name":"logical_switch_id","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"enum":["LogicalRouterUpLinkPort","LogicalRouterDownLinkPort","LogicalRouterLinkPortOnTIER0","LogicalRouterLinkPortOnTIER1","LogicalRouterLoopbackPort","LogicalRouterIPTunnelPort","LogicalRouterCentralizedServicePort"],"description":"Resource types of logical router port","required":false,"in":"query","type":"string","name":"resource_type"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Logical Router Ports"],"summary":"List Logical Router Ports","x-vmw-nsx-module":"LogicalRouterPorts","consumes":["application/json"],"operationId":"ListLogicalRouterPorts"}},"/realization-state-barrier/config":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RealizationStateBarrierConfig"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Updates the barrier configuration having interval set in milliseconds\nThe new interval that automatically increments the global realization number\n","parameters":[{"schema":{"$ref":"#/definitions/RealizationStateBarrierConfig"},"required":true,"name":"RealizationStateBarrierConfig","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","System Properties","Realization State Barrier"],"summary":"Updates the barrier configuration","x-vmw-nsx-module":"RealizationStateBarrier","consumes":["application/json"],"operationId":"UpdateRealizationStateBarrierConfig"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RealizationStateBarrierConfig"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the current barrier configuration\n","produces":["application/json"],"tags":["System Administration","Configuration","System Properties","Realization State Barrier"],"summary":"Gets the realization state barrier configuration","x-vmw-nsx-module":"RealizationStateBarrier","consumes":["application/json"],"operationId":"GetRealizationStateBarrierConfig"}},"/upgrade/{component-type}?action=execute_post_upgrade_checks":{"post":{"responses":{"202":{"description":"Accepted"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"description":"Internal Server Error"}},"description":"Run pre-defined checks to identify issues after upgrade of a component. The\nresults of the checks are added to the respective upgrade units\naggregate-info. The progress and status of post-upgrade checks is part of\naggregate-info of individual upgrade unit groups.\nReturns HTTP status 500 with error code 30953 if execution of post-upgrade\nchecks is already in progress.\n","parameters":[{"required":true,"type":"string","name":"component-type","in":"path"}],"tags":["System Administration","Lifecycle Management","Upgrade","Plan"],"summary":"Execute post-upgrade checks","x-vmw-nsx-module":"Upgrade","consumes":["application/json"],"operationId":"ExecutePostUpgradeChecks"}},"/serviceinsertion/service-attachments":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ServiceAttachment"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Adds a new Service attachment. A service attachment represents a point\non NSX entity (Example: Logical Router) to which service instance can be\nconnected through an InstanceEndpoint.\n","parameters":[{"schema":{"$ref":"#/definitions/ServiceAttachment"},"required":true,"name":"ServiceAttachment","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Add a Service Attachment.","x-vmw-nsx-module":"ServiceInsertion","consumes":["application/json"],"operationId":"AddServiceAttachment"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ServiceAttachmentListResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns all Service-Attachement(s) present in the system.\n","produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Get all service attachments.","x-vmw-nsx-module":"ServiceInsertion","consumes":["application/json"],"operationId":"ListServiceAttachments"}},"/directory/domains/{domain-id}/ldap-servers":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/DirectoryLdapServer"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"More than one LDAP server can be created and only one LDAP server is used to synchronize directory objects. If more than one LDAP server is configured, NSX will try all the servers until it is able to successfully connect to one.","parameters":[{"description":"Directory domain identifier","required":true,"type":"string","name":"domain-id","in":"path"},{"schema":{"$ref":"#/definitions/DirectoryLdapServer"},"required":true,"name":"DirectoryLdapServer","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Directory Service","LDAP Servers"],"summary":"Create a LDAP server for directory domain","x-vmw-nsx-module":"DirectoryService","consumes":["application/json"],"operationId":"CreateDirectoryLdapServer"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DirectoryLdapServerListResults"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"List all configured domain LDAP servers","parameters":[{"description":"Directory domain identifier","required":true,"type":"string","name":"domain-id","in":"path"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["System Administration","Configuration","Directory Service","LDAP Servers"],"summary":"List all configured domain LDAP servers","x-vmw-nsx-module":"DirectoryService","consumes":["application/json"],"operationId":"ListDirectoryLdapServers"}},"/node/status?action=clear_bootup_error":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Clear node bootup status\n","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Settings"],"summary":"Update node status","x-vmw-nsx-module":"NodeStatus","consumes":["application/json"],"operationId":"UpdateApplianceNodeStatusClearBootupError"}},"/directory/domains/{domain-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DirectoryDomain"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update to any field in the directory domain will trigger a full sync","parameters":[{"description":"Directory domain identifier","required":true,"type":"string","name":"domain-id","in":"path"},{"schema":{"$ref":"#/definitions/DirectoryDomain"},"required":true,"name":"DirectoryDomain","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Directory Service","Domains"],"summary":"Update a directory domain","x-vmw-nsx-module":"DirectoryService","consumes":["application/json"],"operationId":"UpdateDirectoryDomain"},"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Invoke full sync or delta sync for a specific domain, with additional delay in seconds if needed. Stop sync will try to stop any pending sync if any to return to idle state.","parameters":[{"description":"Directory domain identifier","required":true,"type":"string","name":"domain-id","in":"path"},{"enum":["FULL_SYNC","DELTA_SYNC","STOP_SYNC"],"description":"Sync type requested","required":true,"in":"query","type":"string","name":"action"},{"description":"Request to execute the sync with some delay in seconds","format":"int64","default":0,"required":false,"minimum":0,"in":"query","type":"integer","name":"delay"}],"produces":["application/json"],"tags":["System Administration","Configuration","Directory Service","Domains"],"summary":"Invoke full sync or delta sync for a specific domain, with additional delay in seconds if needed. Stop sync will try to stop any pending sync if any to return to idle state.","x-vmw-nsx-module":"DirectoryService","consumes":["application/json"],"operationId":"RequestDirectoryDomainSync"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete a specific domain with given identifier","parameters":[{"description":"Directory domain identifier","required":true,"type":"string","name":"domain-id","in":"path"},{"default":false,"description":"Force delete the resource even if it is being used somewhere\n","type":"boolean","name":"force","in":"query"}],"produces":["application/json"],"tags":["System Administration","Configuration","Directory Service","Domains"],"summary":"Delete a specific domain with given identifier","x-vmw-nsx-module":"DirectoryService","consumes":["application/json"],"operationId":"DeleteDirectoryDomain"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DirectoryDomain"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get a specific domain with given identifier","parameters":[{"description":"Directory domain identifier","required":true,"type":"string","name":"domain-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","Directory Service","Domains"],"summary":"Get a specific domain with given identifier","x-vmw-nsx-module":"DirectoryService","consumes":["application/json"],"operationId":"GetDirectoryDomain"}},"/node/services/async_replicator/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read the Async Replicator service status","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Async Replicator Service"],"summary":"Read the Async Replicator service status","x-vmw-nsx-module":"NodeAsyncReplicatorService","consumes":["application/json"],"operationId":"ReadAsyncReplicatorServiceStatus"}},"/mirror-sessions":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/PortMirroringSession"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Create a mirror session","parameters":[{"schema":{"$ref":"#/definitions/PortMirroringSession"},"required":true,"name":"PortMirroringSession","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Troubleshooting And Monitoring","Port Mirroring"],"summary":"Create a mirror session","x-vmw-nsx-module":"PortMirroring","consumes":["application/json"],"operationId":"CreatePortMirroringSessions"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PortMirroringSessionListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"List all mirror sessions","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Troubleshooting And Monitoring","Port Mirroring"],"summary":"List all mirror sessions","x-vmw-nsx-module":"PortMirroring","consumes":["application/json"],"operationId":"ListPortMirroringSession"}},"/sites?version=latest":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FederationConfiguration"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"description":"Service Unavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get the site configuration, some attributes won't be shown based on version","produces":["application/json"],"tags":["System Administration","Configuration","Site Management"],"summary":"Get the site configuration, some attributes won't be shown based on version","x-vmw-nsx-module":"SiteManagerModule","consumes":["application/json"],"operationId":"GetSiteConfigurationVersionedLatest"}},"/fabric/vifs":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/VirtualNetworkInterfaceListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about all VIFs. A virtual network interface aggregates\nnetwork interfaces into a logical interface unit that is indistinuishable\nfrom a physical network interface.\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Id of the host where this vif is located.","required":false,"type":"string","name":"host_id","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"LPort Attachment Id of the virtual network interface.","required":false,"type":"string","name":"lport_attachment_id","in":"query"},{"description":"External id of the virtual machine.","required":false,"type":"string","name":"owner_vm_id","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"description":"Internal identifier of the virtual machine.","required":false,"type":"string","name":"vm_id","in":"query"}],"produces":["application/json"],"tags":["Policy","Inventory","Virtual Interfaces"],"summary":"Return the List of Virtual Network Interfaces (VIFs)","x-vmw-nsx-module":"Inventory","consumes":["application/json"],"operationId":"ListVifs"}},"/firewall/excludelist?action=add_member":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResourceReference"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Add a new object in the exclude list.","parameters":[{"schema":{"$ref":"#/definitions/ResourceReference"},"required":true,"name":"ResourceReference","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Firewall"],"summary":"Add a new object in the exclude list.","x-vmw-nsx-module":"ExcludeList","consumes":["application/json"],"operationId":"AddMember"}},"/node/support-bundle":{"get":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read node support bundle","parameters":[{"default":false,"description":"Include all files","type":"boolean","name":"all","in":"query"}],"produces":["application/octet-stream"],"tags":["System Administration","Configuration","Fabric","Nodes","Support-Bundle"],"summary":"Read node support bundle","x-vmw-nsx-module":"NodeStatusReport","consumes":["application/json"],"operationId":"ReadNodeSupportBundle"}},"/node/services/ntp?action=start":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the NTP service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","NTP"],"summary":"Restart, start or stop the NTP service","x-vmw-nsx-module":"NodeNTPService","consumes":["application/json"],"operationId":"CreateNTPServiceActionStart"}},"/transport-nodes/{edge-node-id}/inter-site/statistics":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeInterSiteStatistics"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns RTEP to RTEP tunnel port statistics of the given edge node.\nIt always returns realtime response.\n","parameters":[{"required":true,"type":"string","name":"edge-node-id","in":"path"}],"produces":["application/json"],"tags":["Federation","Inter-Sites"],"summary":"Get inter-site statistics of edge node","x-vmw-nsx-module":"AggSvcInterSite","consumes":["application/json"],"operationId":"GetInterSiteEdgeNodeStatistics"}},"/dns/forwarders/{forwarder-id}/nslookup":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DnsAnswer"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Query the nameserver for an ip-address or a FQDN of the given an address optionally using\nan specified DNS server. If the address is a fqdn, nslookup will resolve ip-address with it.\nIf the address is an ip-address, do a reverse lookup and answer fqdn(s).\n","parameters":[{"required":true,"type":"string","name":"forwarder-id","in":"path"},{"description":"IP address or FQDN for nslookup","required":false,"type":"string","name":"address","in":"query"},{"description":"IPv4 address","format":"ipv4","required":false,"in":"query","type":"string","name":"server_ip"},{"description":"IPv4 address","format":"ipv4","required":false,"in":"query","type":"string","name":"source_ip"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","DNS"],"summary":"Resolve a given address via the DNS forwarder","x-vmw-nsx-module":"DnsForwarder","consumes":["application/json"],"operationId":"LookupAddress"}},"/node/services/telemetry?action=restart":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop Telemetry service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Telemetry Service"],"summary":"Restart, start or stop Telemetry service","x-vmw-nsx-module":"NodePhonehomeCoordinatorService","consumes":["application/json"],"operationId":"CreatePhonehomeCoordinatorServiceActionRestart"}},"/trust-management/crl-distribution-points/{crl-distribution-point-id}/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/CrlDistributionPointStatus"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Return the status of the CrlDistributionPoint","parameters":[{"required":true,"type":"string","name":"crl-distribution-point-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Settings","Certificates","CRL"],"summary":"Return the status of the CrlDistributionPoint","x-vmw-nsx-module":"CertificateManager","consumes":["application/json"],"operationId":"GetCrlDistributionPointStatus"}},"/node/services/search":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read NSX Search service properties","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Search Service"],"summary":"Read NSX Search service properties","x-vmw-nsx-module":"NodeSearchService","consumes":["application/json"],"operationId":"ReadSearchService"}},"/transport-zones":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/TransportZone"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Creates a new transport zone. The required parameters are host_switch_name\nand transport_type (OVERLAY or VLAN). The optional parameters are\ndescription and display_name. This api is now deprecated. Please use new api -\nPUT /infra/sites/<site-id>/enforcement-points/<enforcementpoint-\nid>/transport-zones/<zone-id>\n","parameters":[{"schema":{"$ref":"#/definitions/TransportZone"},"required":true,"name":"TransportZone","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Transport Zones"],"summary":"Create a Transport Zone","x-vmw-nsx-module":"TransportZone","consumes":["application/json"],"operationId":"CreateTransportZone"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TransportZoneListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about configured transport zones. NSX requires at\nleast one transport zone. NSX uses transport zones to provide connectivity\nbased on the topology of the underlying network, trust zones, or\norganizational separations. For example, you might have hypervisors that\nuse one network for management traffic and a different network for VM\ntraffic. This architecture would require two transport zones. The\ncombination of transport zones plus transport connectors enables NSX to\nform tunnels between hypervisors. Transport zones define which interfaces\non the hypervisors can communicate with which other interfaces on other\nhypervisors to establish overlay tunnels or provide connectivity to a VLAN.\nA logical switch can be in one (and only one) transport zone. This means\nthat all of a switch's interfaces must be in the same transport zone.\nHowever, each hypervisor virtual switch (OVS or VDS) has multiple\ninterfaces (connectors), and each connector can be attached to a different\nlogical switch. For example, on a single hypervisor with two connectors,\nconnector A can be attached to logical switch 1 in transport zone A, while\nconnector B is attached to logical switch 2 in transport zone B. In this\nway, a single hypervisor can participate in multiple transport zones. The\nAPI for creating a transport zone requires that a single host switch be\nspecified for each transport zone, and multiple transport zones can share\nthe same host switch. This api is now deprecated. Please use new api -\n/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/transport-zones\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"The transport zone's display name","type":"string","name":"display_name","in":"query"},{"description":"Filter to indicate whether to include system owned Transport Zones.","default":false,"required":false,"in":"query","type":"boolean","name":"include_system_owned"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Filter to choose if default transport zones will be returned","type":"boolean","name":"is_default","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"description":"Filter to choose the type of transport zones to return","enum":["OVERLAY","VLAN"],"type":"string","name":"transport_type","in":"query"},{"description":"The transport zone's uplink teaming policy name","required":false,"type":"string","name":"uplink_teaming_policy_name","in":"query"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Transport Zones"],"summary":"List Transport Zones","x-vmw-nsx-module":"TransportZone","consumes":["application/json"],"operationId":"ListTransportZones"}},"/vpn/ipsec/dpd-profiles/{ipsec-vpn-dpd-profile-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IPSecVPNDPDProfile"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Edit IPSec dead peer detection (DPD) profile.","parameters":[{"required":true,"type":"string","name":"ipsec-vpn-dpd-profile-id","in":"path"},{"schema":{"$ref":"#/definitions/IPSecVPNDPDProfile"},"required":true,"name":"IPSecVPNDPDProfile","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","VPN","IPSEC","DPD Profiles"],"summary":"Edit IPSec dead peer detection (DPD) profile","x-vmw-nsx-module":"IPSecVPN","consumes":["application/json"],"operationId":"UpdateIPSecVPNDPDProfile"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete dead peer detection (DPD) profile.","parameters":[{"required":true,"type":"string","name":"ipsec-vpn-dpd-profile-id","in":"path"},{"default":false,"description":"Force delete the resource even if it is being used somewhere\n","type":"boolean","name":"force","in":"query"}],"tags":["Management Plane API","Networking","VPN","IPSEC","DPD Profiles"],"summary":"Delete dead peer detection (DPD) profile","x-vmw-nsx-module":"IPSecVPN","consumes":["application/json"],"operationId":"DeleteIPSecVPNDPDProfile"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IPSecVPNDPDProfile"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get IPSec dead peer detection (DPD) profile.","parameters":[{"required":true,"type":"string","name":"ipsec-vpn-dpd-profile-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","VPN","IPSEC","DPD Profiles"],"summary":"Get IPSec dead peer detection (DPD) profile","x-vmw-nsx-module":"IPSecVPN","consumes":["application/json"],"operationId":"GetIPSecVPNDPDProfile"}},"/licenses/licenses-usage?format=csv":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FeatureUsageListInCsvFormat"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns usage report of all registered modules in CSV format\n","produces":["text/csv"],"tags":["System Administration","Settings","Licenses"],"summary":"Get usage report of all registred modules in CSV format","x-vmw-nsx-module":"License","consumes":["application/json"],"operationId":"GetLicenseUsageReportInCsvFormat"}},"/ui-views/{view-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/View"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update View","parameters":[{"required":true,"type":"string","name":"view-id","in":"path"},{"schema":{"$ref":"#/definitions/View"},"required":true,"name":"View","in":"body"}],"produces":["application/json"],"tags":["System Administration","Monitoring","Dashboards","UI Views"],"summary":"Update View","x-vmw-nsx-module":"NsxDashboard","consumes":["application/json"],"operationId":"UpdateView"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/View"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns Information about a specific View.\n","parameters":[{"required":true,"type":"string","name":"view-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Monitoring","Dashboards","UI Views"],"summary":"Returns View Information","x-vmw-nsx-module":"NsxDashboard","consumes":["application/json"],"operationId":"GetView"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete View","parameters":[{"required":true,"type":"string","name":"view-id","in":"path"}],"tags":["System Administration","Monitoring","Dashboards","UI Views"],"summary":"Delete View","x-vmw-nsx-module":"NsxDashboard","consumes":["application/json"],"operationId":"DeletView"}},"/pools/ip-blocks/{block-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IpBlock"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"409":{"description":"Conflict"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Modifies the IP address block with specifed id. display_name, description\nand cidr are parameters that can be modified. If a new cidr is specified,\nit should contain all existing subnets in the IP block. Returns a conflict error\nif the IP address block cidr can not be modified due to the presence of\nsubnets that it contains. Eg: If the IP block contains a subnet 192.168.0.1/24\nand we try to change the IP block cidr to 10.1.0.1/16, it results in a conflict.\n","parameters":[{"description":"IP address block id","required":true,"type":"string","name":"block-id","in":"path"},{"schema":{"$ref":"#/definitions/IpBlock"},"required":true,"name":"IpBlock","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Pool Management","IP Blocks"],"summary":"Update an IP Address Block","x-vmw-nsx-module":"Ipam","consumes":["application/json"],"operationId":"UpdateIpBlock"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IpBlock"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about the IP address block with specified id.\nInformation includes id, display_name, description & cidr.\n","parameters":[{"description":"IP address block id","required":true,"type":"string","name":"block-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Pool Management","IP Blocks"],"summary":"Get IP address block information.","x-vmw-nsx-module":"Ipam","consumes":["application/json"],"operationId":"ReadIpBlock"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Deletes the IP address block with specified id if it exists. IP\nblock cannot be deleted if there are allocated subnets from the block.\n","parameters":[{"description":"IP address block id","required":true,"type":"string","name":"block-id","in":"path"}],"tags":["System Administration","Configuration","Fabric","Pool Management","IP Blocks"],"summary":"Delete an IP Address Block","x-vmw-nsx-module":"Ipam","consumes":["application/json"],"operationId":"DeleteIpBlock"}},"/ipfix/collectorconfigs":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/IpfixCollectorConfig"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"description":"Bad Request"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Create a new IPFIX collector configuration","parameters":[{"schema":{"$ref":"#/definitions/IpfixCollectorConfig"},"required":true,"name":"IpfixCollectorConfig","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Troubleshooting And Monitoring","IPFIX"],"summary":"Create a new IPFIX collector configuration","x-vmw-nsx-module":"Ipfix","consumes":["application/json"],"operationId":"CreateIpfixCollectorConfig"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IpfixCollectorConfigListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"List IPFIX collector configurations","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Troubleshooting And Monitoring","IPFIX"],"summary":"List IPFIX collector configurations","x-vmw-nsx-module":"Ipfix","consumes":["application/json"],"operationId":"ListIpfixCollectorConfig"}},"/logical-routers/{logical-router-id}?action=reallocate":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LogicalRouter"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"API to re allocate edge node placement for TIER1 logical router. You can\nre-allocate service routers of TIER1 in same edge cluster or different edge\ncluster. You can also place edge nodes manually and provide maximum two\nindices for HA mode ACTIVE_STANDBY. To re-allocate on new edge cluster you\nmust have existing edge cluster for TIER1 logical router. This will be\ndisruptive operation and all existing statistics of logical router will be\nremove.\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"schema":{"$ref":"#/definitions/ServiceRouterAllocationConfig"},"required":true,"name":"ServiceRouterAllocationConfig","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Logical Routers"],"summary":"Re allocate edge node placement of TIER1 service routers","x-vmw-nsx-module":"LogicalRouter","consumes":["application/json"],"operationId":"ReAllocateServiceRouters"}},"/cluster/restore?action=cancel":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ClusterRestoreStatus"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"500":{"$ref":"#/responses/InternalServerError"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ClusterRestoreStatus"}}},"description":"This operation is only valid when a restore is in suspended state. The UI user\ncan cancel any restore operation when the restore is suspended either due\nto an error, or for a user input. The API user would need to monitor the\nprogression of a restore by calling periodically\n\"/api/v1/cluster/restore/status\" API. The response object\n(ClusterRestoreStatus), contains a field \"endpoints\". The API user can cancel\nthe restore process if 'cancel' action is shown in the endpoint field. This\noperation is only valid when a GET cluster/restore/status returns a status\nwith value SUSPENDED.\n","produces":["application/json"],"tags":["System Administration","Lifecycle Management","Backup Restore Management","Restore"],"summary":"Cancel any running restore operation","x-vmw-nsx-module":"ClusterRestore","consumes":["application/json"],"operationId":"CancelClusterRestore"}},"/sites/switchover-status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SwitchoverStatus"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"description":"Service Unavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get the switchover status","produces":["application/json"],"tags":["System Administration","Configuration","Site Management"],"summary":"Get the switchover status","x-vmw-nsx-module":"SiteManagerModule","consumes":["application/json"],"operationId":"MakeActiveStatus"}},"/trust-management/csrs/{csr-id}/pem-file":{"get":{"responses":{"200":{"description":"OK","schema":{"type":"string"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Downloads the CSR PEM file for a specified CSR. Clients must include an Accept: text/plain request header.","parameters":[{"description":"ID of CSR to read","required":true,"type":"string","name":"csr-id","in":"path"}],"produces":["text/plain;charset=UTF-8"],"tags":["System Administration","Settings","Certificates","CSR"],"summary":"Get CSR PEM File for the Given CSR ID","x-vmw-nsx-module":"CertificateManager","consumes":["application/json"],"operationId":"GetCsrPem"}},"/firewall/sections/{section-id}/rules/stats":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FirewallStatsList"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get aggregated statistics for all rules for a given firewall section. The\nAPI only supports access to cached (source=cached) statistical data\ncollected offline in the system. Data includes total number of packets,\nbytes, sessions counters and popularity index for a firewall rule and\noverall session count, max session count and max popularity index for\nall firewall rules on transport nodes or edge nodes. Aggregated\nstatistics like maximum popularity index, maximum session count and\ntotal session count are computed with lower frequency compared to\nindividual generic rule statistics, hence they may have a computation\ndelay up to 15 minutes to reflect in response to this API.\n","parameters":[{"required":true,"type":"string","name":"section-id","in":"path"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Firewall"],"summary":"Get Firewall section level statistics section","x-vmw-nsx-module":"FirewallStatsRule","consumes":["application/json"],"operationId":"GetFirewallSectionStats"}},"/search/dsl":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SearchResponse"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"description":"Bad Request"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"DSL (Domain Specific Language) search API","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"description":"Search query","required":true,"type":"string","name":"query","in":"query"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Search","Search API"],"summary":"DSL (Domain Specific Language) search API","x-vmw-nsx-module":"Search","consumes":["application/json"],"operationId":"DslSearch"}},"/logical-routers/{logical-router-id}/nat/rules/statistics":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NatStatisticsPerLogicalRouter"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the summation of statistics for all rules from all nodes for the Specified\nLogical Router. Also gives the per transport node statistics for provided logical router.\nThe query parameter \"source=realtime\" is not supported.\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","NAT"],"summary":"Get the statistics of all rules of the logical router","x-vmw-nsx-module":"AggSvcLogicalRouter","consumes":["application/json"],"operationId":"GetNatStatisticsPerLogicalRouter"}},"/cluster/restore?action=advance":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ClusterRestoreStatus"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"500":{"$ref":"#/responses/InternalServerError"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ClusterRestoreStatus"}}},"description":"Advance any currently suspended restore operation. The operation might\nhave been suspended because (1) the user had suspended it previously, or\n(2) the operation is waiting for user input, to be provided as a\npart of the POST request body. This operation is only valid\nwhen a GET cluster/restore/status returns a status with value SUSPENDED.\nOtherwise, a 409 response is returned.\n","parameters":[{"schema":{"$ref":"#/definitions/AdvanceClusterRestoreRequest"},"required":true,"name":"AdvanceClusterRestoreRequest","in":"body"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Backup Restore Management","Restore"],"summary":"Advance any suspended restore operation","x-vmw-nsx-module":"ClusterRestore","consumes":["application/json"],"operationId":"AdvanceClusterRestore"}},"/latency-profiles":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/LatencyStatProfile"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"description":"Bad Request"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Create a new latency profile","parameters":[{"schema":{"$ref":"#/definitions/LatencyStatProfile"},"required":true,"name":"LatencyStatProfile","in":"body"}],"produces":["application/json"],"tags":["System Administration","Monitoring","Latency Profiles"],"summary":"Create a new latency profile","x-vmw-nsx-module":"Latency","consumes":["application/json"],"operationId":"CreateLatencyStatProfile"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LatencyStatProfileListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"List latency profiles","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["System Administration","Monitoring","Latency Profiles"],"summary":"List latency profiles","x-vmw-nsx-module":"Latency","consumes":["application/json"],"operationId":"ListLatencyProfiles"}},"/trust-management/certificates?action=set_appliance_proxy_certificate_for_inter_site_communication":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Set a certificate that has been imported to be the Appliance Proxy certificate\nused for communicating with Appliance Proxies on other sites.\n","parameters":[{"schema":{"$ref":"#/definitions/SetInterSiteAphCertificateRequest"},"required":true,"name":"SetInterSiteAphCertificateRequest","in":"body"}],"tags":["System Administration","Settings","Certificates","Certificate"],"summary":"Set a certificate as the Appliance Proxy certificate to be used in inter-site communication","x-vmw-nsx-module":"CertificateManager","consumes":["application/json"],"operationId":"SetInterSiteAphCertificate"}},"/idfw/vm-stats/{vm-ext-id}":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IdfwVmStats"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get IDFW user login events for a given VM (all active plus up to 5 most\nrecent archived entries).\n","parameters":[{"required":true,"type":"string","name":"vm-ext-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Security","Identity Firewall","Realization Data"],"summary":"Get IDFW user login events for a given VM","x-vmw-nsx-module":"IdentityFirewall","consumes":["application/json"],"operationId":"GetVmStats"}},"/aaa/user-info":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UserInfo"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"This API will return the name and role information of the user\ninvoking this API request. This API is available for all NSX users\nno matter their authentication method (Local account, VIDM, LDAP etc).\n","parameters":[{"description":"Prefix path of the context","required":false,"type":"string","name":"root_path","in":"query"}],"produces":["application/json"],"tags":["System Administration","Settings","User Management","Users"],"summary":"Get the name and role information of the user.","x-vmw-nsx-module":"AAA","consumes":["application/json"],"operationId":"GetCurrentUserInfo"}},"/loadbalancer/application-profiles":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/LbAppProfile"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Create a load balancer application profile.\n","parameters":[{"schema":{"$ref":"#/definitions/LbAppProfile"},"required":true,"name":"LbAppProfile","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Create a load balancer application profile","x-vmw-nsx-module":"LoadBalancer","consumes":["application/json"],"operationId":"CreateLoadBalancerApplicationProfile"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LbAppProfileListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Retrieve a paginated list of load balancer application profiles.\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"enum":["LbHttpProfile","LbFastTcpProfile","LbFastUdpProfile"],"description":"application profile type","required":false,"in":"query","type":"string","name":"type"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Retrieve a paginated list of load balancer application profiles","x-vmw-nsx-module":"LoadBalancer","consumes":["application/json"],"operationId":"ListLoadBalancerApplicationProfiles"}},"/ns-groups/{ns-group-id}/effective-physical-server-members":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EffectiveMemberResourceListResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns effective physical server members of the specified NSGroup.\nThis API is applicable only for NSGroups containing Physical Server member type.\nFor NSGroups containing other member types,it returns an empty list.\n","parameters":[{"description":"NSGroup Id","required":true,"type":"string","name":"ns-group-id","in":"path"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Grouping Objects","NS Groups"],"summary":"Get Effective Physical Server Memebers of the specified NSGroup.","x-vmw-nsx-module":"NSGroup","consumes":["application/json"],"operationId":"GetEffectivePhysicalServerMembers"}},"/node/services/ssh/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read ssh service status","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","SSH"],"summary":"Read ssh service status","x-vmw-nsx-module":"NodeSSHService","consumes":["application/json"],"operationId":"ReadSSHServiceStatus"}},"/migration/migration-unit-groups":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/MigrationUnitGroup"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Create a group of migration units.\n","parameters":[{"schema":{"$ref":"#/definitions/MigrationUnitGroup"},"required":true,"name":"MigrationUnitGroup","in":"body"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Migration","Group"],"summary":"Create a group","x-vmw-nsx-module":"Migration","consumes":["application/json"],"operationId":"CreateMigrationUnitGroup"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MigrationUnitGroupListResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Return information of all migration unit groups in the\nmigration plan. If request parameter summary is set to true, then\nonly count of migration units will be returned, migration units list\nwill be empty. If request parameter component type is specified,\nthen all migration unit groups for that component will be returned.\n","parameters":[{"description":"Component type based on which migration unit groups to be filtered","required":false,"type":"string","name":"component_type","in":"query"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"description":"Flag indicating whether to return summary","default":false,"required":false,"in":"query","type":"boolean","name":"summary"},{"description":"Synchronize before returning migration unit groups","default":false,"required":false,"in":"query","type":"boolean","name":"sync"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Migration","Group"],"summary":"Return information of all migration unit groups","x-vmw-nsx-module":"Migration","consumes":["application/json"],"operationId":"GetMigrationUnitGroups"}},"/trust-management/oidc-uris":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/OidcEndPoint"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"description":"Internal Server Error"}},"description":"This request also fetches the issuer and jwks_uri meta-data from the OIDC\nend-point and stores it.\n","parameters":[{"schema":{"$ref":"#/definitions/OidcEndPoint"},"required":true,"name":"OidcEndPoint","in":"body"}],"produces":["application/json"],"tags":["System Administration","Settings","User Management","Principal Identity"],"summary":"Add an OpenID Connect end-point.","x-vmw-nsx-module":"CertificateManager","consumes":["application/json"],"operationId":"AddOidcEndPoint"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/OidcEndPointListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Return the list of OpenID Connect end-points.","produces":["application/json"],"tags":["System Administration","Settings","User Management","Principal Identity"],"summary":"Return the list of OpenID Connect end-points.","x-vmw-nsx-module":"CertificateManager","consumes":["application/json"],"operationId":"ListOidcEndPoints"}},"/firewall/sections/{section-id}?action=revise":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FirewallSection"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Modifies an existing firewall section along with its relative position\namong other firewall sections in the system. Simultaneous update (modify)\noperations on same section are not allowed to prevent overwriting stale\ncontents to firewall section. If a concurrent update is performed, HTTP\nresponse code 409 will be returned to the client operating on stale data.\nThat client should retrieve the firewall section again and re-apply its\nupdate.\n","parameters":[{"required":true,"type":"string","name":"section-id","in":"path"},{"schema":{"$ref":"#/definitions/FirewallSection"},"required":true,"name":"FirewallSection","in":"body"},{"in":"query","description":"Identifier of the anchor rule or section. This is a required field in case operation like 'insert_before' and 'insert_after'.","required":false,"maxLength":64,"type":"string","name":"id"},{"enum":["insert_top","insert_bottom","insert_after","insert_before"],"description":"Operation","default":"insert_top","required":false,"in":"query","type":"string","name":"operation"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Firewall"],"summary":"Update an Existing Section, Including Its Position","x-vmw-nsx-module":"Firewall","consumes":["application/json"],"operationId":"ReviseSection"}},"/node/services/snmp?action=stop":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the SNMP service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","SNMP"],"summary":"Restart, start or stop the SNMP service","x-vmw-nsx-module":"NodeSNMPService","consumes":["application/json"],"operationId":"CreateSNMPServiceActionStop"}},"/systemhealth/appliances/{appliance-id}/latency/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ApplianceLatencyData"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Show the details of process status in given appliance.\n","parameters":[{"required":true,"type":"string","name":"appliance-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Monitoring","System Health","Appliance","Process"],"summary":"Show the details of process status in given appliance","x-vmw-nsx-module":"ShaApplianceMonitor","consumes":["application/json"],"operationId":"ShowApplianceLatencyData"}},"/pools/mac-pools/{pool-id}":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MacPool"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about the specified MAC pool.\n","parameters":[{"description":"MAC pool ID","required":true,"type":"string","name":"pool-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Pool Management","MAC Pools"],"summary":"Read MAC Pool","x-vmw-nsx-module":"MACAM","consumes":["application/json"],"operationId":"ReadMacPool"}},"/node/aaa/auth-policy":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AuthenticationPolicyProperties"}},"202":{"description":"Accepted","schema":{"$ref":"#/definitions/AuthenticationPolicyProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update the currently configured authentication policy on the node.\nIf any of api_max_auth_failures, api_failed_auth_reset_period, or\napi_failed_auth_lockout_period are modified, the http service is\nautomatically restarted.\n","parameters":[{"schema":{"$ref":"#/definitions/AuthenticationPolicyProperties"},"required":true,"name":"AuthenticationPolicyProperties","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","User Management","Authentication Policy"],"summary":"Update node authentication policy configuration","x-vmw-nsx-module":"AuthenticationPolicyModule","consumes":["application/json"],"operationId":"UpdateAuthenticationPolicyProperties"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AuthenticationPolicyProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about the currently configured authentication\npolicies on the node.\n","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","User Management","Authentication Policy"],"summary":"Read node authentication policy configuration","x-vmw-nsx-module":"AuthenticationPolicyModule","consumes":["application/json"],"operationId":"ReadAuthenticationPolicyProperties"}},"/node/services/async_replicator":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeAsyncReplicatorServiceProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update the async_replicator service properties","parameters":[{"schema":{"$ref":"#/definitions/NodeAsyncReplicatorServiceProperties"},"required":true,"name":"NodeAsyncReplicatorServiceProperties","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","NSX Managers","Nodes","Services","Async Replicator Service"],"summary":"Update the async_replicator service properties","x-vmw-nsx-module":"NodeAsyncReplicatorService","consumes":["application/json"],"operationId":"UpdateAsyncReplicatorService"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeAsyncReplicatorServiceProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read the Async Replicator service properties","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Async Replicator Service"],"summary":"Read the Async Replicator service properties","x-vmw-nsx-module":"NodeAsyncReplicatorService","consumes":["application/json"],"operationId":"ReadAsyncReplicatorService"}},"/node/services/nsx-message-bus?action=restart":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the NSX Message Bus service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","NSX Message Service"],"summary":"Restart, start or stop the NSX Message Bus service","x-vmw-nsx-module":"NodeNSXMessageBusService","consumes":["application/json"],"operationId":"CreateNSXMessageBusServiceActionRestart"}},"/vpn/ipsec/peer-endpoints":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/IPSecVPNPeerEndpoint"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Create custom IPSec peer endpoint.","parameters":[{"schema":{"$ref":"#/definitions/IPSecVPNPeerEndpoint"},"required":true,"name":"IPSecVPNPeerEndpoint","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","VPN","IPSEC","Peer Endpoints"],"summary":"Create custom peer endpoint","x-vmw-nsx-module":"IPSecVPN","consumes":["application/json"],"operationId":"CreateIPSecVPNPeerEndPoint"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IPSecVPNPeerEndpointListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get paginated list of all peer endpoint.","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","VPN","IPSEC","Peer Endpoints"],"summary":"Get IPSecVPNPeerEndpoint List Result","x-vmw-nsx-module":"IPSecVPN","consumes":["application/json"],"operationId":"ListIPSecVPNPeerEndpoints"}},"/switching-profiles/{switching-profile-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BaseSwitchingProfile"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Updates the user-configurable parameters of a switching profile. Only the qos,\nport-mirroring, spoof-guard and port-security switching profiles can be modified.\nYou cannot modify the ipfix or ip-discovery switching profiles. This api is now deprecated.\nUse new api, for eg., QOS profile - PATCH /infra/qos-profiles/<qos-profile-id>\n","parameters":[{"required":true,"type":"string","name":"switching-profile-id","in":"path"},{"schema":{"$ref":"#/definitions/BaseSwitchingProfile"},"required":true,"name":"BaseSwitchingProfile","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Switching","Logical Switch Ports"],"summary":"Update a Switching Profile","x-vmw-nsx-module":"BaseSwitchingProfile","consumes":["application/json"],"operationId":"UpdateSwitchingProfile"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BaseSwitchingProfile"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about a specified switching profile. This api is now deprecated. Please use new api - for QOS profile, please use - /infra/qos-profiles/<qos-profile-id>","parameters":[{"required":true,"type":"string","name":"switching-profile-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Switching","Logical Switch Ports"],"summary":"Get Switching Profile by ID","x-vmw-nsx-module":"BaseSwitchingProfile","consumes":["application/json"],"operationId":"GetSwitchingProfile"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Deletes the specified switching profile. This api is now deprecated. Use new api - for QOS profile, please use - DELETE /infra/qos-profiles/<qos-profile-id>","parameters":[{"required":true,"type":"string","name":"switching-profile-id","in":"path"},{"description":"force unbinding of logical switches and ports from a switching profile","default":false,"required":false,"in":"query","type":"boolean","name":"unbind"}],"tags":["Management Plane API","Networking","Logical Switching","Logical Switch Ports"],"summary":"Delete a Switching Profile","x-vmw-nsx-module":"BaseSwitchingProfile","consumes":["application/json"],"operationId":"DeleteSwitchingProfile"}},"/upgrade?action=abort_pre_upgrade_checks":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Aborts execution of pre-upgrade checks if already in progress. Halts the\nexecution of checks awaiting execution at this point and makes best-effort\nattempts to stop checks already in execution. Returns without action if\nexecution of pre-upgrade checks is not in progress.\n","tags":["System Administration","Lifecycle Management","Upgrade","Plan"],"summary":"Abort pre-upgrade checks","x-vmw-nsx-module":"Upgrade","consumes":["application/json"],"operationId":"AbortPreUpgradeChecks"}},"/ipfix-profiles":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/IpfixUpmProfile"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"description":"Bad Request"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Create a new IPFIX profile with essential properties.","parameters":[{"schema":{"$ref":"#/definitions/IpfixUpmProfile"},"required":true,"name":"IpfixUpmProfile","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Troubleshooting And Monitoring","IPFIX"],"summary":"Create a new IPFIX profile","x-vmw-nsx-module":"UpmIpfix","consumes":["application/json"],"operationId":"CreateIpfixUpmProfile"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IpfixUpmProfileListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Query IPFIX profiles with list parameters. List result can be filtered by\nprofile type defined by IpfixUpmProfileType.\n","parameters":[{"description":"ID of Entity Applied with Profile","required":false,"type":"string","name":"applied_to_entity_id","in":"query"},{"enum":["LogicalPort","LogicalSwitch","NSGroup"],"description":"Supported Entity Types","required":false,"in":"query","type":"string","name":"applied_to_entity_type"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"description":"IPFIX Profile Type List","required":false,"type":"string","name":"profile_types","in":"query"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Troubleshooting And Monitoring","IPFIX"],"summary":"List IPFIX Profies","x-vmw-nsx-module":"UpmIpfix","consumes":["application/json"],"operationId":"ListIpfixUpmProfiles"}},"/loadbalancer/monitors/{monitor-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LbMonitor"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update a load balancer monitor.\n","parameters":[{"required":true,"type":"string","name":"monitor-id","in":"path"},{"schema":{"$ref":"#/definitions/LbMonitor"},"required":true,"name":"LbMonitor","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Update a load balancer monitor","x-vmw-nsx-module":"LoadBalancer","consumes":["application/json"],"operationId":"UpdateLoadBalancerMonitor"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LbMonitor"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Retrieve a load balancer monitor.\n","parameters":[{"required":true,"type":"string","name":"monitor-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Retrieve a load balancer monitor","x-vmw-nsx-module":"LoadBalancer","consumes":["application/json"],"operationId":"ReadLoadBalancerMonitor"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete a load balancer monitor.\n","parameters":[{"required":true,"type":"string","name":"monitor-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Delete a load balancer monitor","x-vmw-nsx-module":"LoadBalancer","consumes":["application/json"],"operationId":"DeleteLoadBalancerMonitor"}},"/upgrade/upgrade-units":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UpgradeUnitListResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get upgrade units","parameters":[{"description":"Component type based on which upgrade units to be filtered","required":false,"type":"string","name":"component_type","in":"query"},{"description":"Current version of upgrade unit based on which upgrade units to be filtered","required":false,"type":"string","name":"current_version","in":"query"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"UUID of group based on which upgrade units to be filtered","required":false,"type":"string","name":"group_id","in":"query"},{"description":"Flag to indicate whether to return only upgrade units with warnings","default":false,"required":false,"in":"query","type":"boolean","name":"has_warnings"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Metadata about upgrade unit to filter on","required":false,"type":"string","name":"metadata","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"description":"Upgrade unit type based on which upgrade units to be filtered","required":false,"type":"string","name":"upgrade_unit_type","in":"query"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Upgrade","Upgrade Units"],"summary":"Get upgrade units","x-vmw-nsx-module":"Upgrade","consumes":["application/json"],"operationId":"GetUpgradeUnits"}},"/cluster/restore/config":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RestoreConfiguration"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Deprecated. Please use API /cluster/backups/config, to configure\nremote file server(where backed-up files are stored) details\nduring restore. In older versions\n- Configure file server where the backed-up files used for the Restore\noperation are available.\n","parameters":[{"schema":{"$ref":"#/definitions/RestoreConfiguration"},"required":true,"name":"RestoreConfiguration","in":"body"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Backup Restore Management","Restore"],"summary":"Deprecated. Configure Restore SFTP server credentials","x-vmw-nsx-module":"BackupConfiguration","consumes":["application/json"],"operationId":"ConfigureRestoreConfig"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RestoreConfiguration"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Deprecated. Please use API /cluster/backups/config, to get remote file server(where\nbackuped-up files are stored) details durign restore. In older versions\n- Get configuration information for the file server used to store backed-up files.\nFields that contain secrets (password, passphrase) are not returned.\n","produces":["application/json"],"tags":["System Administration","Lifecycle Management","Backup Restore Management","Restore"],"summary":"Deprecated. Get Restore configuration","x-vmw-nsx-module":"BackupConfiguration","consumes":["application/json"],"operationId":"GetRestoreConfig"}},"/node/services/syslog/exporters?action=verify":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Collect iptables rules needed for all existing syslog exporters and verify\nif the existing iptables rules are the same. If not, remove the stale rules\nand add the new rules to make sure all exporters work properly.\n","tags":["System Administration","Configuration","Fabric","Nodes","Services","Syslog"],"summary":"Verify node syslog exporter","x-vmw-nsx-module":"NodeSyslogExporters","consumes":["application/json"],"operationId":"VerifyNodeSyslogExporterVerify"}},"/node/services/cm-inventory":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read cm inventory service properties","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Cm Inventory Service"],"summary":"Read cm inventory service properties","x-vmw-nsx-module":"NodeCminventoryService","consumes":["application/json"],"operationId":"ReadCminventoryService"}},"/cluster/api-virtual-ip?action=clear_virtual_ip":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ClusterVirtualIpProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Clears the cluster virtual IP address.\n","produces":["application/json"],"tags":["System Administration","Configuration","NSX Managers","Clusters","Cluster Virtual IP"],"summary":"Clear cluster virtual IP address","x-vmw-nsx-module":"ClusterVirtualIp","consumes":["application/json"],"operationId":"ClearClusterVirtualIpClearVirtualIp"}},"/switching-profiles":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/BaseSwitchingProfile"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Creates a new, custom qos, port-mirroring, spoof-guard or port-security\nswitching profile. You can override their default switching profile assignments\nby creating a new switching profile and assigning it to one or more logical\nswitches. You cannot override the default ipfix or ip_discovery switching profiles.\nThis api is now deprecated. Please use new api -\nFor eg. for QOS profile, please use - PUT /infra/qos-profiles/<qos-profile-id>\n","parameters":[{"schema":{"$ref":"#/definitions/BaseSwitchingProfile"},"required":true,"name":"BaseSwitchingProfile","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Switching","Logical Switch Ports"],"summary":"Create a Switching Profile","x-vmw-nsx-module":"BaseSwitchingProfile","consumes":["application/json"],"operationId":"CreateSwitchingProfile"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SwitchingProfilesListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about the system-default and user-configured switching\nprofiles. Each switching profile has a unique ID, a display name, and\nvarious other read-only and configurable properties. The default switching\nprofiles are assigned automatically to each switch. This api is now deprecated.\nPlease use new api - for QOS profile, please use - /infra/qos-profiles\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Whether the list result contains system resources","default":false,"required":false,"in":"query","type":"boolean","name":"include_system_owned"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"description":"comma-separated list of switching profile types, e.g. ?switching_profile_type=QosSwitchingProfile,IpDiscoverySwitchingProfile","required":false,"type":"string","name":"switching_profile_type","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Switching","Logical Switch Ports"],"summary":"List Switching Profiles","x-vmw-nsx-module":"BaseSwitchingProfile","consumes":["application/json"],"operationId":"ListSwitchingProfiles"}},"/systemhealth/transport-nodes/{node-id}/container/hyperbus/status":{"get":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/TnHyperbusStatus"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get the containter hyperbus status on given node","parameters":[{"required":true,"type":"string","name":"node-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Monitoring","System Health","Container"],"summary":"Get the containter hyperbus status on given node","x-vmw-nsx-module":"TnContainerStatus","consumes":["application/json"],"operationId":"ReadTnHyperbusStatus"}},"/cluster/restore?action=suspend":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ClusterRestoreStatus"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"500":{"$ref":"#/responses/InternalServerError"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ClusterRestoreStatus"}}},"description":"Suspend any currently running restore operation. The restore operation is\nmade up of a number of steps. When this call is issued, any currently\nrunning step is allowed to finish (successfully or with errors), and the\nnext step (and therefore the entire restore operation) is suspended until\na subsequent resume or cancel call is issued. This operation is only valid\nwhen a GET cluster/restore/status returns a status with value RUNNING.\nOtherwise, a 409 response is returned.\n","produces":["application/json"],"tags":["System Administration","Lifecycle Management","Backup Restore Management","Restore"],"summary":"Suspend any running restore operation","x-vmw-nsx-module":"ClusterRestore","consumes":["application/json"],"operationId":"SuspendClusterRestore"}},"/ipfix-profiles/{ipfix-profile-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IpfixUpmProfile"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update an existing IPFIX profile with profile ID and modified properties.\n","parameters":[{"required":true,"type":"string","name":"ipfix-profile-id","in":"path"},{"schema":{"$ref":"#/definitions/IpfixUpmProfile"},"required":true,"name":"IpfixUpmProfile","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Troubleshooting And Monitoring","IPFIX"],"summary":"Update an existing IPFIX profile","x-vmw-nsx-module":"UpmIpfix","consumes":["application/json"],"operationId":"UpdateIpfixUpmProfile"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IpfixUpmProfile"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get an existing IPFIX profile by profile ID.","parameters":[{"required":true,"type":"string","name":"ipfix-profile-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Troubleshooting And Monitoring","IPFIX"],"summary":"Get an existing IPFIX profile","x-vmw-nsx-module":"UpmIpfix","consumes":["application/json"],"operationId":"GetIpfixUpmProfile"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete an existing IPFIX profile by ID.","parameters":[{"required":true,"type":"string","name":"ipfix-profile-id","in":"path"}],"tags":["Management Plane API","Troubleshooting And Monitoring","IPFIX"],"summary":"Delete an existing IPFIX profile","x-vmw-nsx-module":"UpmIpfix","consumes":["application/json"],"operationId":"DeleteIpfixUpmProfile"}},"/loadbalancer/client-ssl-profiles/{client-ssl-profile-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LbClientSslProfile"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update a load balancer client-ssl profile.\n","parameters":[{"required":true,"type":"string","name":"client-ssl-profile-id","in":"path"},{"schema":{"$ref":"#/definitions/LbClientSslProfile"},"required":true,"name":"LbClientSslProfile","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Update a load balancer client-ssl profile","x-vmw-nsx-module":"LoadBalancer","consumes":["application/json"],"operationId":"UpdateLoadBalancerClientSslProfile"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LbClientSslProfile"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Retrieve a load balancer client-ssl profile.\n","parameters":[{"required":true,"type":"string","name":"client-ssl-profile-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Retrieve a load balancer client-ssl profile","x-vmw-nsx-module":"LoadBalancer","consumes":["application/json"],"operationId":"ReadLoadBalancerClientSslProfile"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete a load balancer client-ssl profile.\n","parameters":[{"required":true,"type":"string","name":"client-ssl-profile-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Delete a load balancer client-ssl profile","x-vmw-nsx-module":"LoadBalancer","consumes":["application/json"],"operationId":"DeleteLoadBalancerClientSslProfile"}},"/ns-groups/{ns-group-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NSGroup"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Updates the specified NSGroup. Modifiable parameters include the\ndescription, display_name and members.\nFor NSGroups containing VM criteria(both static and dynamic), system VMs will\nnot be included as members. This filter applies at VM level only.\nExceptions are as follows.\n1. LogicalPorts and VNI of system VMs will be included in NSGroup if the criteria\n is based on LogicalPort, LogicalSwitch or VNI directly.\n","parameters":[{"description":"NSGroup Id","required":true,"type":"string","name":"ns-group-id","in":"path"},{"schema":{"$ref":"#/definitions/NSGroup"},"required":true,"name":"NSGroup","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Grouping Objects","NS Groups"],"summary":"Update NSGroup","x-vmw-nsx-module":"NSGroup","consumes":["application/json"],"operationId":"UpdateNSGroup"},"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NSGroup"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Add/remove the expressions passed in the request body to/from the NSGroup\n","parameters":[{"description":"NSGroup Id","required":true,"type":"string","name":"ns-group-id","in":"path"},{"schema":{"$ref":"#/definitions/NSGroupExpressionList"},"required":true,"name":"NSGroupExpressionList","in":"body"},{"enum":["ADD_MEMBERS","REMOVE_MEMBERS"],"description":"Specifies addition or removal action","required":true,"in":"query","type":"string","name":"action"}],"produces":["application/json"],"tags":["Management Plane API","Grouping Objects","NS Groups"],"summary":"Add NSGroup expression","x-vmw-nsx-module":"NSGroup","consumes":["application/json"],"operationId":"AddOrRemoveNSGroupExpression"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NSGroup"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about the specified NSGroup.\n","parameters":[{"description":"NSGroup Id","required":true,"type":"string","name":"ns-group-id","in":"path"},{"default":false,"description":"Populate metadata of resource referenced by NSGroupExpressions\n","type":"boolean","name":"populate_references","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Grouping Objects","NS Groups"],"summary":"Read NSGroup","x-vmw-nsx-module":"NSGroup","consumes":["application/json"],"operationId":"ReadNSGroup"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Deletes the specified NSGroup. By default, if the NSGroup is added to\nanother NSGroup, it won't be deleted. In such situations, pass\n\"force=true\" as query param to force delete the NSGroup.\n","parameters":[{"description":"NSGroup Id","required":true,"type":"string","name":"ns-group-id","in":"path"},{"default":false,"description":"Force delete the resource even if it is being used somewhere\n","type":"boolean","name":"force","in":"query"}],"tags":["Management Plane API","Grouping Objects","NS Groups"],"summary":"Delete NSGroup","x-vmw-nsx-module":"NSGroup","consumes":["application/json"],"operationId":"DeleteNSGroup"}},"/transport-nodes/{node-id}/statistics/nat-rules":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NatStatisticsPerTransportNode"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the summation of statistics for all rules from all logical routers\nwhich are present on given transport node. Only cached statistics are supported.\nThe query parameter \"source=realtime\" is not supported.\n","parameters":[{"required":true,"type":"string","name":"node-id","in":"path"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","NAT"],"summary":"Get statistics for all logical router NAT rules on a transport node","x-vmw-nsx-module":"AggSvcLogicalRouter","consumes":["application/json"],"operationId":"GetNatStatisticsPerTransportNode"}},"/upgrade/eula/content":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EULAContent"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Return the content of end user license agreement in the specified format.\nBy default, it's pure string without line break\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"description":"End User License Agreement content output format","type":"string","name":"value_format","in":"query"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Upgrade","Eula"],"summary":"Return the content of end user license agreement\n","x-vmw-nsx-module":"UpgradeEULA","consumes":["application/json"],"operationId":"GetUpgradeEULAContent"}},"/loadbalancer/services/{service-id}/pools/statistics":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LbPoolStatisticsListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the statistics list of load balancer pools in given load balancer service.\nCurrently, only realtime mode is supported.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Get the statistics list of load balancer pools","x-vmw-nsx-module":"AggSvcLb","consumes":["application/json"],"operationId":"ListLoadBalancerPoolStatistics"}},"/cluster/nodes/{node-id}/repo_sync/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RepoSyncStatusReport"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the synchronization status for the manager represented by given <node-id>.\n","parameters":[{"required":true,"type":"string","name":"node-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","NSX Managers","Clusters","Cluster Node Deployments"],"summary":"Synchronizes the repository data between nsx managers.","x-vmw-nsx-module":"ClusterNodeVMDeployment","consumes":["application/json"],"operationId":"GetRepoSyncStatus"}},"/upgrade/bundles":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UpgradeBundleId"}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Fetches the upgrade bundle from url. The call returns after fetch is initiated.\nCheck status by periodically retrieving upgrade bundle upload status\nusing GET /upgrade/bundles/<bundle-id>/upload-status.\nThe upload is complete when the status is SUCCESS.\n","parameters":[{"schema":{"$ref":"#/definitions/UpgradeBundleFetchRequest"},"required":true,"name":"UpgradeBundleFetchRequest","in":"body"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Upgrade","Bundles"],"summary":"Fetch upgrade bundle from given url","x-vmw-nsx-module":"Upgrade","consumes":["application/json"],"operationId":"FetchUpgradeBundleFromUrl"}},"/cluster/api-virtual-ip?action=set_virtual_ip":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ClusterVirtualIpProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"409":{"description":"Conflict"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Sets the cluster virtual IP address. Note, all nodes in the management\ncluster must be in the same subnet. If not, a 409 CONFLICT status is\nreturned.\n","parameters":[{"description":"Virtual IP address, 0.0.0.0 if not configured","required":true,"type":"string","name":"ip_address","in":"query"}],"produces":["application/json"],"tags":["System Administration","Configuration","NSX Managers","Clusters","Cluster Virtual IP"],"summary":"Set cluster virtual IP address","x-vmw-nsx-module":"ClusterVirtualIp","consumes":["application/json"],"operationId":"SetClusterVirtualIpSetVirtualIp"}},"/loadbalancer/services/{service-id}/virtual-servers/{virtual-server-id}/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LbVirtualServerStatus"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the status of the virtual server by given load balancer serives id\nand load balancer virtual server id.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"required":true,"type":"string","name":"virtual-server-id","in":"path"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Get the status of the load balancer virtual server","x-vmw-nsx-module":"AggSvcLb","consumes":["application/json"],"operationId":"GetLoadBalancerVirtualServerStatus"}},"/serviceinsertion/sections/{section-id}?action=revise":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ServiceInsertionSection"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Modifies an existing serviceinsertion section along with its relative position\namong other serviceinsertion sections in the system.\nNote- POST service insertion section API is deprecated.\nPlease use policy redirection-policy API.\n","parameters":[{"required":true,"type":"string","name":"section-id","in":"path"},{"schema":{"$ref":"#/definitions/ServiceInsertionSection"},"required":true,"name":"ServiceInsertionSection","in":"body"},{"in":"query","description":"Identifier of the anchor rule or section. This is a required field in case operation like 'insert_before' and 'insert_after'.","required":false,"maxLength":64,"type":"string","name":"id"},{"enum":["insert_top","insert_bottom","insert_after","insert_before"],"description":"Operation","default":"insert_top","required":false,"in":"query","type":"string","name":"operation"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Update an Existing Section, Including Its Position","x-vmw-nsx-module":"ServiceInsertionRules","consumes":["application/json"],"operationId":"ReviseServiceInsertionSection"}},"/loadbalancer/services/{service-id}/virtual-servers/{virtual-server-id}/statistics":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LbVirtualServerStatistics"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the statistics of the load balancer virtual server by given load\n balancer serives id and load balancer virtual server id.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"required":true,"type":"string","name":"virtual-server-id","in":"path"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Get the statistics of the given load balancer virtual server","x-vmw-nsx-module":"AggSvcLb","consumes":["application/json"],"operationId":"GetLoadBalancerVirtualServerStatistics"}},"/ns-groups/{ns-group-id}/effective-virtual-machine-members":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/VirtualMachineListResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns effective virtual machine members of the specified NSGroup.\nThis API is applicable only for NSGroups containing VirtualMachine member type.\nFor NSGroups containing other member types,it returns an empty list.\n","parameters":[{"description":"NSGroup Id","required":true,"type":"string","name":"ns-group-id","in":"path"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Grouping Objects","NS Groups"],"summary":"Get Effective Virtual Machine members of the specified NSGroup.","x-vmw-nsx-module":"NSGroup","consumes":["application/json"],"operationId":"GetEffectiveVirtualMachineMembers"}},"/firewall/sections/{section-id}/rules/{rule-id}?action=revise":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FirewallRule"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Modifies existing firewall rule along with relative position among\nother firewall rules inside a firewall section. Revising firewall rule in a\nsection modifies parent section entity and simultaneous update (modify)\noperations on same section are not allowed to prevent overwriting stale\ncontents to firewall section. If a concurrent update is performed, HTTP\nresponse code 409 will be returned to the client operating on stale data.\nThat client should retrieve the firewall section again and re-apply its\nupdate.\n","parameters":[{"required":true,"type":"string","name":"section-id","in":"path"},{"required":true,"type":"string","name":"rule-id","in":"path"},{"schema":{"$ref":"#/definitions/FirewallRule"},"required":true,"name":"FirewallRule","in":"body"},{"in":"query","description":"Identifier of the anchor rule or section. This is a required field in case operation like 'insert_before' and 'insert_after'.","required":false,"maxLength":64,"type":"string","name":"id"},{"enum":["insert_top","insert_bottom","insert_after","insert_before"],"description":"Operation","default":"insert_top","required":false,"in":"query","type":"string","name":"operation"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Firewall"],"summary":"Update an Existing Rule and Reorder the Rule","x-vmw-nsx-module":"Firewall","consumes":["application/json"],"operationId":"ReviseRule"}},"/node/services/controller/profiler":{"put":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"description":"Internal Server Error"}},"description":"Enable or disable controller profiler","parameters":[{"schema":{"$ref":"#/definitions/ControllerProfilerProperties"},"required":true,"name":"ControllerProfilerProperties","in":"body"}],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Controller Service"],"summary":"Enable or disable controller profiler","x-vmw-nsx-module":"ControllerProfilerModule","consumes":["application/json"],"operationId":"SetControllerProfiler"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ControllerProfilerProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get the status (Enabled/Disabled) of controller profiler","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Controller Service"],"summary":"Get the status (Enabled/Disabled) of controller profiler","x-vmw-nsx-module":"ControllerProfilerModule","consumes":["application/json"],"operationId":"GetControllerProfilerStatus"}},"/node/tasks/{task-id}?action=cancel":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Cancel specified task","parameters":[{"description":"ID of task to delete","required":true,"type":"string","name":"task-id","in":"path"}],"tags":["System Administration","Configuration","Fabric","Nodes","Services","Tasks"],"summary":"Cancel specified task","x-vmw-nsx-module":"ApplianceManagementTaskModule","consumes":["application/json"],"operationId":"CancelApplianceManagementTaskCancel"}},"/fabric/compute-collections/{cc-ext-id}/network/physical-interfaces":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ComputeCollectionNetworkInterfacesListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns list of physical network interfaces for all discovered nodes in\ncompute collection. Interface information includes PNIC name, hostswitch\nname it's attached to(if any) and MAC address.\n","parameters":[{"required":true,"type":"string","name":"cc-ext-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Compute Collections"],"summary":"List the Physical Network Interface for all discovered nodes","x-vmw-nsx-module":"InventoryCmObj","consumes":["application/json"],"operationId":"ListComputeCollectionPhysicalNetworkInterfaces"}},"/loadbalancer/services/{service-id}/usage":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LbServiceUsage"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"API to fetch the capacity and current usage of the given load balancer\nservice.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Read the usage information of the given load balancer service","x-vmw-nsx-module":"LoadBalancer","consumes":["application/json"],"operationId":"ReadLoadBalancerServiceUsage"}},"/serviceinsertion/service-chains/{service-chain-id}":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ServiceChain"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns detailed service chain information.\n","parameters":[{"required":true,"type":"string","name":"service-chain-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Get a particular service chain.","x-vmw-nsx-module":"ServiceInsertion","consumes":["application/json"],"operationId":"GetServiceChain"},"delete":{"responses":{"200":{"description":"OK"},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete a particular service chain.\n","parameters":[{"required":true,"type":"string","name":"service-chain-id","in":"path"}],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Delete a Service Chain.","x-vmw-nsx-module":"ServiceInsertion","consumes":["application/json"],"operationId":"DeleteServiceChain"}},"/trust-management/principal-identities/{principal-identity-id}":{"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete a principal identity. It does not delete the certificate.\n","parameters":[{"description":"Unique id of the principal identity to delete","required":true,"type":"string","name":"principal-identity-id","in":"path"}],"tags":["System Administration","Settings","User Management","Principal Identity"],"summary":"Delete a principal identity","x-vmw-nsx-module":"CertificateManager","consumes":["application/json"],"operationId":"DeletePrincipalIdentity"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PrincipalIdentity"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get a stored principal identity\n","parameters":[{"description":"ID of the principal identity to get","required":true,"type":"string","name":"principal-identity-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Settings","User Management","Principal Identity"],"summary":"Get a principal identity","x-vmw-nsx-module":"CertificateManager","consumes":["application/json"],"operationId":"GetPrincipalIdentity"}},"/node/file-store/{file-name}":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/FileProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"409":{"description":"Conflict"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"When you issue this API, the client must specify:\n- HTTP header Content-Type:application/octet-stream.\n- Request body with the contents of the file in the filestore.\nIn the CLI, you can view the filestore with the get files command.\n","parameters":[{"description":"Destination filename","required":true,"type":"string","name":"file-name","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","File Store"],"summary":"Upload a file to the file store","x-vmw-nsx-module":"FileStoreModule","consumes":["application/octet-stream"],"operationId":"CreateFile"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete file","parameters":[{"description":"Name of the file to delete","required":true,"type":"string","name":"file-name","in":"path"}],"tags":["System Administration","Configuration","Fabric","Nodes","File Store"],"summary":"Delete file","x-vmw-nsx-module":"FileStoreModule","consumes":["application/json"],"operationId":"DeleteFile"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FileProperties"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read file properties","parameters":[{"description":"Name of the file to retrieve information about","required":true,"type":"string","name":"file-name","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","File Store"],"summary":"Read file properties","x-vmw-nsx-module":"FileStoreModule","consumes":["application/json"],"operationId":"ReadFileProperties"}},"/serviceinsertion/services/{service-id}/service-deployments":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/ServiceDeployment"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"This will deploy a particular service on a given cluster / host. Internally multiple service instance can be\ncreated during the deployment. If there are no issues in the parameters, the call returns immediately,\nand the service VMs will be deployed asynchronously. To get the overall status of the deployment or to get\nthe status of individual service vm, please use the deployment status APIs.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"schema":{"$ref":"#/definitions/ServiceDeployment"},"required":true,"name":"ServiceDeployment","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Deploys a particular service","x-vmw-nsx-module":"ServiceInsertionVMDeployment","consumes":["application/json"],"operationId":"DeployService"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ServiceDeploymentListResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the list of deployments for the given service\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Get all service deployments for the given service id","x-vmw-nsx-module":"ServiceInsertionVMDeployment","consumes":["application/json"],"operationId":"GetServiceDeployments"}},"/ns-groups/{ns-group-id}/effective-vif-members":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/VirtualNetworkInterfaceListResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns effective VIF members of the specified NSGroup.\nThis API is applicable only for NSGroups containing either\nVirtualMachines or VIF member type. For NSGroups containing other\nmember types,it returns an empty list.\n","parameters":[{"description":"NSGroup Id","required":true,"type":"string","name":"ns-group-id","in":"path"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Grouping Objects","NS Groups"],"summary":"Get effective VIF members translated from the NSGroup","x-vmw-nsx-module":"NSGroup","consumes":["application/json"],"operationId":"GetEffectiveVIFMembers"}},"/livetraces/{livetrace-session-id}/proxy/forward/capturefile":{"get":{"responses":{"200":{"description":"OK"},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"You must provide the request header\n\"Accept:application/octet-stream\" when calling this API.\nThe capture file can only be found in MP which receives the capture request.\n","parameters":[{"description":"Livetrace session ID","required":true,"type":"string","name":"livetrace-session-id","in":"path"}],"produces":["application/octet-stream"],"tags":["Management Plane API","Troubleshooting And Monitoring","Livetrace"],"summary":"Get forward packet capture file proxy","x-vmw-nsx-module":"LiveTrace","consumes":["application/json"],"operationId":"GetForwardPktCapFileProxy"}},"/serviceinsertion/services/{service-id}/service-instances/{service-instance-id}/instance-runtimes":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/InstanceRuntimeListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns list of instance runtimes of service VMs being deployed for a given service instance id\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"required":true,"type":"string","name":"service-instance-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Returns list of instance runtimes of service VM being deployed","x-vmw-nsx-module":"ServiceInsertionVMDeployment","consumes":["application/json"],"operationId":"ListInstanceRuntimes"}},"/vpn/ipsec/dpd-profiles":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/IPSecVPNDPDProfile"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Create dead peer detection (DPD) profile. Any change in profile affects all sessions consuming this profile.","parameters":[{"schema":{"$ref":"#/definitions/IPSecVPNDPDProfile"},"required":true,"name":"IPSecVPNDPDProfile","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","VPN","IPSEC","DPD Profiles"],"summary":"Create dead peer detection (DPD) profile","x-vmw-nsx-module":"IPSecVPN","consumes":["application/json"],"operationId":"CreateIPSecVPNDPDProfile"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IPSecVPNDPDProfileListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get paginated list of all dead peer detection (DPD) profiles.","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","VPN","IPSEC","DPD Profiles"],"summary":"Get IPSec dead peer detection (DPD) profile list result","x-vmw-nsx-module":"IPSecVPN","consumes":["application/json"],"operationId":"ListIPSecVPNDPDProfiles"}},"/serviceinsertion/service-managers":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/ServiceManager"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Register service-manager with NSX with basic details like name, username, password.","parameters":[{"schema":{"$ref":"#/definitions/ServiceManager"},"required":true,"name":"ServiceManager","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Register service manager","x-vmw-nsx-module":"ServiceInsertion","consumes":["application/json"],"operationId":"RegisterServiceManager"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ServiceManagerListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"List all service managers.\n","produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"List service managers","x-vmw-nsx-module":"ServiceInsertion","consumes":["application/json"],"operationId":"ListServiceManagers"}},"/fabric/physical-servers":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PhysicalServerListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information of all physical/bare metal servers registered as TN.","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Display Name of the physical server","required":false,"type":"string","name":"display_name","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"enum":["RHELSERVER","UBUNTUSERVER","CENTOSSERVER","SLESSERVER","WINDOWSSERVER","OELSERVER"],"description":"OS type of the physical server","required":false,"in":"query","type":"string","name":"os_type"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Physical Servers"],"summary":"Return the list of physical servers","x-vmw-nsx-module":"PhysicalServer","consumes":["application/json"],"operationId":"ListPhysicalServers"}},"/intelligence/nodes/deployments/{node-id}?action=delete":{"post":{"responses":{"202":{"description":"Accepted"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"description":"Bad Request"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Attempts to unregister and undeploy a specified auto-deployed cluster\nnode VM. If it is a member of a cluster, then the VM will be automatically\ndetached from the cluster before being unregistered and undeployed.\nAlternatively, if the original deployment attempt failed or the VM is\nnot found, cleans up the deployment information associated with the\ndeployment attempt.\nNote: If a VM has been successfully auto-deployed, then the associated\ndeployment information will not be deleted unless and until the VM is\nsuccessfully deleted.\n","parameters":[{"required":true,"type":"string","name":"node-id","in":"path"},{"description":"Delete by force","type":"boolean","name":"force_delete","in":"query"}],"tags":["System Administration","Configuration","NSX Intelligence","Deployments"],"summary":"Attempt to delete an auto-deployed cluster node VM","x-vmw-nsx-module":"NsxIntelligenceDeployment","consumes":["application/json"],"operationId":"DeleteAutoDeployedPaceClusterNodeVM"}},"/cluster/nodes/deployments":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/ClusterNodeVMDeploymentRequestList"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Deploys a cluster node VM as specified by the deployment config.\nOnce the VM is deployed and powered on, it will automatically join the\nexisting cluster.\n","parameters":[{"schema":{"$ref":"#/definitions/AddClusterNodeVMInfo"},"required":true,"name":"AddClusterNodeVMInfo","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","NSX Managers","Clusters","Cluster Node Deployments"],"summary":"Deploy and register a cluster node VM","x-vmw-nsx-module":"ClusterNodeVMDeployment","consumes":["application/json"],"operationId":"AddClusterNodeVM"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ClusterNodeVMDeploymentRequestList"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns request information for every attempted deployment of a cluster\nnode VM.\n","produces":["application/json"],"tags":["System Administration","Configuration","NSX Managers","Clusters","Cluster Node Deployments"],"summary":"Returns info for all cluster node VM auto-deployment attempts","x-vmw-nsx-module":"ClusterNodeVMDeployment","consumes":["application/json"],"operationId":"ListClusterNodeVMDeploymentRequests"}},"/ns-profiles/attribute-types":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NSSupportedAttributeTypesResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns supported attribute type strings for NSProfile.\n","produces":["application/json"],"tags":["Management Plane API","Grouping Objects","NS Profiles"],"summary":"List NSProfile supported attribute types","x-vmw-nsx-module":"NSProfile","consumes":["application/json"],"operationId":"ListNSSupportedAttributesTypes"}},"/migration/plan?action=rollback":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Roll back the migration. Changes applied to target NSX will be reverted.\nUse the migration status API to monitor progress of roll back.\n","tags":["System Administration","Lifecycle Management","Migration","Plan"],"summary":"Rollbabck migration","x-vmw-nsx-module":"Migration","consumes":["application/json"],"operationId":"StartRollbackMigration"}},"/node/mpa-config":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MPAConfigProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update the MPA configuration for this node.","parameters":[{"schema":{"$ref":"#/definitions/MPAConfigProperties"},"required":true,"name":"MPAConfigProperties","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","System Properties","Mpa Configuration"],"summary":"Update MPA configuration for this node","x-vmw-nsx-module":"MPAConfigModule","consumes":["application/json"],"operationId":"UpdateMPAConfiguration"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MPAConfigProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Retrieve the MPA configuration for this node to identify the Manager nodes with which this node is communicating.","produces":["application/json"],"tags":["System Administration","Configuration","System Properties","Mpa Configuration"],"summary":"Get MPA configuration for this node","x-vmw-nsx-module":"MPAConfigModule","consumes":["application/json"],"operationId":"ReadMPAConfiguration"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete the MPA configuration for this node.","tags":["System Administration","Configuration","System Properties","Mpa Configuration"],"summary":"Delete MPA configuration for this node","x-vmw-nsx-module":"MPAConfigModule","consumes":["application/json"],"operationId":"DeleteMPAConfiguration"}},"/migration/nodes-summary":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeSummaryList"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get summary of nodes, which includes node count for each type and component version.","produces":["application/json"],"tags":["System Administration","Lifecycle Management","Migration","Nodes"],"summary":"Get summary of nodes","x-vmw-nsx-module":"Migration","consumes":["application/json"],"operationId":"GetMigrationNodesSummary"}},"/loadbalancer/services/{service-id}/pools/{pool-id}/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LbPoolStatus"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the status of the given load balancer pool by given load balancer\nserives id and load balancer pool id.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"required":true,"type":"string","name":"pool-id","in":"path"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Get the status of load balancer pool","x-vmw-nsx-module":"AggSvcLb","consumes":["application/json"],"operationId":"GetLoadBalancerPoolStatus"}},"/tasks/{task-id}":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TaskProperties"}},"303":{"description":"See Other","schema":{"$ref":"#/definitions/TaskProperties"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get information about the specified task","parameters":[{"description":"ID of task to read","required":true,"type":"string","name":"task-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","NSX Managers","API Services","Task Management"],"summary":"Get information about the specified task","x-vmw-nsx-module":"Tasks","consumes":["application/json"],"operationId":"ReadTaskProperties"}},"/mirror-sessions/{mirror-session-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PortMirroringSession"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update the mirror session","parameters":[{"required":true,"type":"string","name":"mirror-session-id","in":"path"},{"schema":{"$ref":"#/definitions/PortMirroringSession"},"required":true,"name":"PortMirroringSession","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Troubleshooting And Monitoring","Port Mirroring"],"summary":"Update the mirror session","x-vmw-nsx-module":"PortMirroring","consumes":["application/json"],"operationId":"UpdatePortMirroringSession"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PortMirroringSession"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get the mirror session","parameters":[{"required":true,"type":"string","name":"mirror-session-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Troubleshooting And Monitoring","Port Mirroring"],"summary":"Get the mirror session","x-vmw-nsx-module":"PortMirroring","consumes":["application/json"],"operationId":"GetPortMirroringSession"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete the mirror session","parameters":[{"required":true,"type":"string","name":"mirror-session-id","in":"path"}],"tags":["Management Plane API","Troubleshooting And Monitoring","Port Mirroring"],"summary":"Delete the mirror session","x-vmw-nsx-module":"PortMirroring","consumes":["application/json"],"operationId":"DeletePortMirroringSession"}},"/node/services/cm-inventory?action=restart":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the manager service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Cm Inventory Service"],"summary":"Restart, start or stop the manager service","x-vmw-nsx-module":"NodeCminventoryService","consumes":["application/json"],"operationId":"CreateCminventoryServiceActionRestart"}},"/node/services/migration-coordinator/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read migration coordinator service status","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Migration Coordinator Service"],"summary":"Read migration coordinator service status","x-vmw-nsx-module":"NodeMigrationCoordinatorService","consumes":["application/json"],"operationId":"ReadMigrationCoordinatorServiceStatus"}},"/events":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EventListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns a list of all Events defined in NSX.","produces":["application/json"],"tags":["System Administration","Monitoring","Alarms And Events"],"summary":"Get the list of all Events defined in NSX.","x-vmw-nsx-module":"Monitoring","consumes":["application/json"],"operationId":"ListEvents"}},"/node/services/policy?action=reset-manager-logging-levels":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Reset the logging levels to default values","tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Policy Service"],"summary":"Reset the logging levels to default values","x-vmw-nsx-module":"NodePolicyService","consumes":["application/json"],"operationId":"ResetPolicyServiceLoggingLevelActionResetManagerLoggingLevels"}},"/fabric/container-applications":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ContainerApplicationListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about all Container Applications.","parameters":[{"description":"Identifier of the container cluster","required":false,"type":"string","name":"container_cluster_id","in":"query"},{"description":"Identifier of the container project","required":false,"type":"string","name":"container_project_id","in":"query"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"description":"Scope id for container cluster","required":false,"type":"string","name":"scope_id","in":"query"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Policy","Inventory","Containers","Container Applications"],"summary":"Return the List of Container Applications","x-vmw-nsx-module":"InventoryContainerObj","consumes":["application/json"],"operationId":"ListContainerApplications"}},"/capacity/usage":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/CapacityUsageResponse"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns capacity usage data for NSX objects","parameters":[{"required":false,"type":"string","name":"category","in":"query"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"default":true,"required":false,"type":"boolean","name":"force","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["System Administration","Monitoring","Dashboards","Capacity Dashboard"],"summary":"Returns capacity usage data for NSX objects","x-vmw-nsx-module":"ProtonCapacityDashboard","consumes":["application/json"],"operationId":"GetProtonCapacityUsage"}},"/events/{event-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MonitoringEvent"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update event identified by event-id.","parameters":[{"required":true,"type":"string","name":"event-id","in":"path"},{"schema":{"$ref":"#/definitions/MonitoringEvent"},"required":true,"name":"MonitoringEvent","in":"body"}],"produces":["application/json"],"tags":["System Administration","Monitoring","Alarms And Events"],"summary":"Update event associated with event-id.","x-vmw-nsx-module":"Monitoring","consumes":["application/json"],"operationId":"UpdateEvent"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MonitoringEvent"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns event associated with event-id.","parameters":[{"required":true,"type":"string","name":"event-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Monitoring","Alarms And Events"],"summary":"Get Events identified by event-id.","x-vmw-nsx-module":"Monitoring","consumes":["application/json"],"operationId":"GetEvent"}},"/serviceinsertion/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ServiceInsertionStatusListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"List all service insertion status for supported contexts","produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"List all service insertion status for supported contexts","x-vmw-nsx-module":"ServiceInsertionStatus","consumes":["application/json"],"operationId":"ListServiceInsertionStatus"}},"/nvds-urt?action=cleanup":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Clean up all nvds upgrade related configurations","tags":["System Administration","Configuration","Fabric","Nodes","Transport Nodes"],"summary":"Clean up all nvds upgrade related configurations","x-vmw-nsx-module":"NvdsUpgradeReadinessCheck","consumes":["application/json"],"operationId":"NvdsUpgradeCleanup"}},"/logical-routers/{logical-router-id}/routing/static-routes/bfd-peers":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/StaticHopBfdPeer"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Creates a BFD peer for static route. The required parameters includes peer IP address.\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"schema":{"$ref":"#/definitions/StaticHopBfdPeer"},"required":true,"name":"StaticHopBfdPeer","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","BFD Peers"],"summary":"Create a static hop BFD peer","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"CreateStaticHopBfdPeer"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/StaticHopBfdPeerListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about all BFD peers created on specified logical router for static routes.\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","BFD Peers"],"summary":"List static routes BFD Peers","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"ListStaticHopBfdPeers"}},"/md-proxies":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/MetadataProxy"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Create a metadata proxy","parameters":[{"schema":{"$ref":"#/definitions/MetadataProxy"},"required":true,"name":"MetadataProxy","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Metadata Proxy"],"summary":"Create a metadata proxy","x-vmw-nsx-module":"MetadataProxy","consumes":["application/json"],"operationId":"CreateMetadataProxy"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MetadataProxyListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get a paginated list of metadata proxies","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Metadata Proxy"],"summary":"Get a paginated list of metadata proxies","x-vmw-nsx-module":"MetadataProxy","consumes":["application/json"],"operationId":"ListMetadataProxy"}},"/intelligence/host-config":{"patch":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IntelligenceHostConfigurationInfo"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Deprecated - Please use the intelligence API /napp/api/v1/intelligence/data-collection/host-config\ninstead, after installing NSX Intelligence.\nPatch the current NSX-Intelligence host configuration.\nReturn error if NSX-Intelligence is not registered with NSX.\n","parameters":[{"schema":{"$ref":"#/definitions/IntelligenceHostConfigurationInfo"},"required":true,"name":"IntelligenceHostConfigurationInfo","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","NSX Intelligence","Host"],"summary":"Patch NSX-Intelligence host configuration","x-vmw-nsx-module":"NsxIntelligenceHostConfiguration","consumes":["application/json"],"operationId":"PatchPaceHostConfiguration"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IntelligenceHostConfigurationInfo"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Deprecated - Please use the intelligence API /napp/api/v1/intelligence/data-collection/host-config\ninstead, after installing NSX Intelligence.\nGet the current NSX-Intelligence host configuration.\nRecommend to keep the value same for flow_data_collection_interval\nand context_data_collection_interval.\n","produces":["application/json"],"tags":["System Administration","Configuration","NSX Intelligence","Host"],"summary":"Get NSX-Intelligence host configuration","x-vmw-nsx-module":"NsxIntelligenceHostConfiguration","consumes":["application/json"],"operationId":"GetPaceHostConfiguration"}},"/ui-views":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/View"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Creates a new View.","parameters":[{"schema":{"$ref":"#/definitions/View"},"required":true,"name":"View","in":"body"}],"produces":["application/json"],"tags":["System Administration","Monitoring","Dashboards","UI Views"],"summary":"Creates a new View.","x-vmw-nsx-module":"NsxDashboard","consumes":["application/json"],"operationId":"CreateView"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ViewList"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"If no query params are specified then all the views entitled for the user\nare returned. The views to which a user is entitled to include the views\ncreated by the user and the shared views.\n","parameters":[{"description":"The tag for which associated views to be queried.","type":"string","name":"tag","in":"query"},{"description":"Ids of the Views","maxLength":8192,"type":"string","name":"view_ids","in":"query"},{"description":"Id of widget configuration","maxLength":255,"type":"string","name":"widget_id","in":"query"}],"produces":["application/json"],"tags":["System Administration","Monitoring","Dashboards","UI Views"],"summary":"Returns the Views based on query criteria defined in ViewQueryParameters.","x-vmw-nsx-module":"NsxDashboard","consumes":["application/json"],"operationId":"ListViews"}},"/serviceinsertion/services/{service-id}/vendor-templates/{vendor-template-id}":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/VendorTemplate"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns detailed vendor template information for a given service.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"required":true,"type":"string","name":"vendor-template-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Get a particular vendor template for a given service.","x-vmw-nsx-module":"ServiceInsertion","consumes":["application/json"],"operationId":"GetVendorTemplate"},"delete":{"responses":{"200":{"description":"OK"},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete vendor template information for a given service.\nPlease make sure to delete all the Service Profile(s), which\nrefer to this vendor tempalte before deleting the template itself.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"required":true,"type":"string","name":"vendor-template-id","in":"path"}],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Delete a particular vendor tempalte.","x-vmw-nsx-module":"ServiceInsertion","consumes":["application/json"],"operationId":"DeleteVendorTemplate"}},"/ns-service-groups/{ns-service-group-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NSServiceGroup"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"409":{"description":"Conflict"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Updates the specified NSService. Modifiable parameters include the description,\ndisplay_name and members.\n","parameters":[{"description":"NSServiceGroup Id","required":true,"type":"string","name":"ns-service-group-id","in":"path"},{"schema":{"$ref":"#/definitions/NSServiceGroup"},"required":true,"name":"NSServiceGroup","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Grouping Objects","NS Service Groups"],"summary":"Update NSServiceGroup","x-vmw-nsx-module":"NSServiceGroup","consumes":["application/json"],"operationId":"UpdateNSServiceGroup"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"409":{"description":"Conflict"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Deletes the specified NSServiceGroup. By default, if the NSServiceGroup is\nconsumed in a Firewall rule, it won't get deleted. In such situations, pass\n\"force=true\" as query param to force delete the NSServiceGroup.\n","parameters":[{"description":"NSServiceGroup Id","required":true,"type":"string","name":"ns-service-group-id","in":"path"},{"default":false,"description":"Force delete the resource even if it is being used somewhere\n","type":"boolean","name":"force","in":"query"}],"tags":["Management Plane API","Grouping Objects","NS Service Groups"],"summary":"Delete NSServiceGroup","x-vmw-nsx-module":"NSServiceGroup","consumes":["application/json"],"operationId":"DeleteNSServiceGroup"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NSServiceGroup"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about the specified NSServiceGroup\n","parameters":[{"description":"NSServiceGroup Id","required":true,"type":"string","name":"ns-service-group-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Grouping Objects","NS Service Groups"],"summary":"Read NSServiceGroup","x-vmw-nsx-module":"NSServiceGroup","consumes":["application/json"],"operationId":"ReadNSServiceGroup"}},"/idfw/system-stats":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IdfwSystemStats"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get IDFW system statistics data.","produces":["application/json"],"tags":["Management Plane API","Security","Identity Firewall","Realization Data"],"summary":"Get IDFW system statistics data","x-vmw-nsx-module":"IdentityFirewall","consumes":["application/json"],"operationId":"GetSystemStats"}},"/livetraces/{livetrace-session-id}":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LiveTraceStatus"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get the status of a livetrace session","parameters":[{"required":true,"type":"string","name":"livetrace-session-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Troubleshooting And Monitoring","Livetrace"],"summary":"Get the status of a livetrace session","x-vmw-nsx-module":"LiveTrace","consumes":["application/json"],"operationId":"GetLiveTraceStatus"},"delete":{"responses":{"200":{"description":"OK"},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete a livetrace session","parameters":[{"required":true,"type":"string","name":"livetrace-session-id","in":"path"}],"tags":["Management Plane API","Troubleshooting And Monitoring","Livetrace"],"summary":"Delete a livetrace session","x-vmw-nsx-module":"LiveTrace","consumes":["application/json"],"operationId":"DeleteLiveTrace"}},"/trust-management/oidc-uris?action=update_thumbprint":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/OidcEndPoint"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update a OpenID Connect end-point's thumbprint used to connect to the\noidc_uri through SSL\n","parameters":[{"schema":{"$ref":"#/definitions/UpdateOidcEndPointThumbprintRequest"},"required":true,"name":"UpdateOidcEndPointThumbprintRequest","in":"body"}],"produces":["application/json"],"tags":["System Administration","Settings","User Management","Principal Identity"],"summary":"Update a OpenID Connect end-point's thumbprint","x-vmw-nsx-module":"CertificateManager","consumes":["application/json"],"operationId":"UpdateOidcEndPointThumbprint"}},"/upgrade/upgrade-checks-info":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ComponentUpgradeChecksInfoListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information of pre-upgrade and post-upgrade checks. If request\nparameter component type is specified, then returns information about\nall pre-upgrade and post-upgrade for the component. Otherwise returns\ninformation of checks across all component types.\n","parameters":[{"description":"Component type based on which upgrade checks are to be filtered","required":false,"type":"string","name":"component_type","in":"query"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Upgrade","Plan"],"summary":"Returns information about upgrade checks","x-vmw-nsx-module":"Upgrade","consumes":["application/json"],"operationId":"GetUpgradeChecksInfo"}},"/vpn/ipsec/sessions":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/IPSecVPNSession"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Create new VPN session.","parameters":[{"schema":{"$ref":"#/definitions/IPSecVPNSession"},"required":true,"name":"IPSecVPNSession","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","VPN","IPSEC","Sessions"],"summary":"Create new VPN session","x-vmw-nsx-module":"IPSecVPN","consumes":["application/json"],"operationId":"CreateIPSecVPNSession"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IPSecVPNSessionListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get paginated list of all IPSec VPN sessions.","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Id of the IPSec VPN service","required":false,"type":"string","name":"ipsec_vpn_service_id","in":"query"},{"description":"Id of logical router","required":false,"type":"string","name":"logical_router_id","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"enum":["PolicyBasedIPSecVPNSession","RouteBasedIPSecVPNSession"],"description":"Resource types of IPsec VPN session","required":false,"in":"query","type":"string","name":"session_type"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","VPN","IPSEC","Sessions"],"summary":"Get IPSec VPN session list result","x-vmw-nsx-module":"IPSecVPN","consumes":["application/json"],"operationId":"ListIPSecVPNSessions"}},"/logical-ports/{lport-id}/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LogicalPortOperationalStatus"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns operational status of a specified logical port.","parameters":[{"required":true,"type":"string","name":"lport-id","in":"path"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Switching","Logical Switch Ports"],"summary":"Get Operational Status for Logical Port of a Given Port ID (lport-id)","x-vmw-nsx-module":"AggSvcLogicalPort","consumes":["application/json"],"operationId":"GetLogicalPortOperationalStatus"}},"/serviceinsertion/services/{service-id}/service-instances/{service-instance-id}/instance-runtimes/{instance-runtime-id}":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Set service VM either in or out of maintenance mode for maintenance mode, or in service or out\nof service for runtime state. Only one value can be set at one time.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"required":true,"type":"string","name":"service-instance-id","in":"path"},{"required":true,"type":"string","name":"instance-runtime-id","in":"path"},{"enum":["enable_maintenance_mode","disable_maintenance_mode","is_healthy","is_stopped","is_not_responding"],"type":"string","name":"action","in":"query"},{"in":"query","description":"Reason for the unhealthy state","required":false,"maxLength":500,"type":"string","name":"unhealthy_reason"}],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Update maintenance mode or runtime state of a service VM","x-vmw-nsx-module":"ServiceInsertionVMDeployment","consumes":["application/json"],"operationId":"UpdateServiceVmState"}},"/ipfix-collector-profiles":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/IpfixCollectorUpmProfile"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"description":"Bad Request"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Create a new IPFIX collector profile with essential properties.","parameters":[{"schema":{"$ref":"#/definitions/IpfixCollectorUpmProfile"},"required":true,"name":"IpfixCollectorUpmProfile","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Troubleshooting And Monitoring","IPFIX"],"summary":"Create a new IPFIX collector profile","x-vmw-nsx-module":"UpmIpfixCollector","consumes":["application/json"],"operationId":"CreateIpfixCollectorUpmProfile"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IpfixCollectorUpmProfileListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Query IPFIX collector profiles with list parameters. List result can be\nfiltered by profile type defined by IpfixCollectorUpmProfileType.\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"description":"IPFIX Collector Profile Type List","required":false,"type":"string","name":"profile_types","in":"query"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Troubleshooting And Monitoring","IPFIX"],"summary":"List IPFIX Collector Profies","x-vmw-nsx-module":"UpmIpfixCollector","consumes":["application/json"],"operationId":"ListIpfixCollectorUpmProfiles"}},"/node/upgrade/performtask":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UpgradeTaskProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Execute upgrade task.\n","parameters":[{"schema":{"$ref":"#/definitions/UpgradeTaskProperties"},"required":true,"name":"UpgradeTaskProperties","in":"body"},{"pattern":"/^[^/]+$/","description":"Upgrade task","type":"string","name":"action","in":"query"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Upgrade","Nodes"],"summary":"Execute upgrade task","x-vmw-nsx-module":"UpgradeNodeActions","consumes":["application/json"],"operationId":"ExecuteUpgradeTask"}},"/upgrade/status-summary":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UpgradeStatus"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get upgrade status summary","parameters":[{"description":"Component type based on which upgrade units to be filtered","required":false,"type":"string","name":"component_type","in":"query"},{"enum":["SELECTED","DESELECTED","ALL"],"description":"Flag to indicate whether to return status for only selected, only deselected or both type of upgrade units","default":"ALL","required":false,"in":"query","type":"string","name":"selection_status"},{"description":"Get upgrade activity for a given component","required":false,"type":"boolean","name":"show_history","in":"query"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Upgrade","Status"],"summary":"Get upgrade status summary","x-vmw-nsx-module":"Upgrade","consumes":["application/json"],"operationId":"GetUpgradeStatusSummary"}},"/serviceinsertion/services/{service-id}/service-profiles/{service-profile-id}/service-chain-mappings":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ServiceChainMappingListResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"List all service chain mappings in the system for the given service profile.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"required":true,"type":"string","name":"service-profile-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"List all ServiceChainMappings.","x-vmw-nsx-module":"ServiceInsertion","consumes":["application/json"],"operationId":"ListServiceChainMappings"}},"/logical-ports/{lport-id}/mac-table?format=csv":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LogicalPortMacAddressCsvListResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns MAC table in CSV format of a specified logical port. If the target transport node id is not provided,\nthe NSX manager will ask the controller for the transport node where the logical port is located.\nThe query parameter \"source=cached\" is not supported. MAC table retrieval is not supported on\nlogical ports that are attached to a logical router.\n","parameters":[{"required":true,"type":"string","name":"lport-id","in":"path"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"},{"description":"TransportNode Id","required":false,"type":"string","name":"transport_node_id","in":"query"}],"produces":["text/csv"],"tags":["Management Plane API","Networking","Logical Switching","Logical Switch Ports"],"summary":"Get MAC table of a logical port with a given port id (lport-id)","x-vmw-nsx-module":"AggSvcLogicalPort","consumes":["application/json"],"operationId":"GetLogicalPortMacTableInCsvFormat"}},"/systemhealth/plugins/{plugin-id}":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SystemHealthPluginProfile"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Show the details of a system health plugin.\n","parameters":[{"required":true,"type":"string","name":"plugin-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Monitoring","System Health","Plugins"],"summary":"Show the details of a system health plugin","x-vmw-nsx-module":"SystemHealthPlugin","consumes":["application/json"],"operationId":"ShowSystemHealthPlugin"},"delete":{"responses":{"200":{"description":"OK"},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete an existing system health plugin by ID.","parameters":[{"required":true,"type":"string","name":"plugin-id","in":"path"}],"tags":["System Administration","Monitoring","System Health","Plugins"],"summary":"Delete an existing system health plugin","x-vmw-nsx-module":"SystemHealthPlugin","consumes":["application/json"],"operationId":"DeleteSystemHealthPlugin"}},"/dhcp/servers/{server-id}/ipv6-ip-pools":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/DhcpV6IpPool"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Create an ip pool for a local DHCP IPv6 server","parameters":[{"required":true,"type":"string","name":"server-id","in":"path"},{"schema":{"$ref":"#/definitions/DhcpV6IpPool"},"required":true,"name":"DhcpV6IpPool","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","DHCP"],"summary":"Create an ip pool for a DHCP IPv6 server","x-vmw-nsx-module":"Dhcp","consumes":["application/json"],"operationId":"CreateDhcpV6IpPool"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DhcpV6IpPoolListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"List the ip pools of a logical DHCP IPv6 server with pagination support.\n","parameters":[{"required":true,"type":"string","name":"server-id","in":"path"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","DHCP"],"summary":"Get a paginated list of a DHCP IPv6 server's IP pools","x-vmw-nsx-module":"Dhcp","consumes":["application/json"],"operationId":"ListDhcpV6IpPools"}},"/failure-domains/{failure-domain-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FailureDomain"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Updates an existing failure domain. Modifiable parameters are\ndisplay_name, preferred_active_edge_services flag.\n","parameters":[{"required":true,"type":"string","name":"failure-domain-id","in":"path"},{"schema":{"$ref":"#/definitions/FailureDomain"},"required":true,"name":"FailureDomain","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Edge Clusters","Failure Domains"],"summary":"Update Failure Domain","x-vmw-nsx-module":"FailureDomain","consumes":["application/json"],"operationId":"UpdateFailureDomain"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Deletes an existing failure domain. You can not delete system generated\ndefault failure domain.\n","parameters":[{"required":true,"type":"string","name":"failure-domain-id","in":"path"}],"tags":["System Administration","Configuration","Fabric","Edge Clusters","Failure Domains"],"summary":"Delete Failure Domain","x-vmw-nsx-module":"FailureDomain","consumes":["application/json"],"operationId":"DeleteFailureDomain"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FailureDomain"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about a single failure domain.","parameters":[{"required":true,"type":"string","name":"failure-domain-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Edge Clusters","Failure Domains"],"summary":"Get a Failure Domain","x-vmw-nsx-module":"FailureDomain","consumes":["application/json"],"operationId":"GetFailureDomain"}},"/transport-nodes/{transport-node-id}/network/interfaces":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeInterfacePropertiesListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the number of interfaces on the node and detailed\ninformation about each interface. Interface information includes MTU,\nbroadcast and host IP addresses, link and admin status, MAC address, network\nmask, and the IP configuration method (static or DHCP).\n","parameters":[{"required":true,"type":"string","name":"transport-node-id","in":"path"},{"description":"Admin status of the interface","enum":["UP","DOWN"],"type":"string","name":"admin_status","in":"query"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Transport Node Interfaces"],"summary":"List the specified transport node's network interfaces","x-vmw-nsx-module":"ApplianceStats","consumes":["application/json"],"operationId":"ListTransportNodeInterfaces"}},"/logical-switches/{lswitch-id}/summary":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LogicalSwitchStatus"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the number of ports assigned to logical switch. This api is now deprecated Please use new API - GET policy/api/v1/infra/realized-state/status?intent_path={{intent-path}}","parameters":[{"required":true,"type":"string","name":"lswitch-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Switching","Logical Switches"],"summary":"Get Logical Switch runtime status info for a given logical switch","x-vmw-nsx-module":"LogicalSwitch","consumes":["application/json"],"operationId":"GetLogicalSwitchStatus"}},"/node/users/{userid}/ssh-keys?action=remove_ssh_key":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"description":"Internal Server Error"}},"description":"Remove SSH public key from authorized_keys file for node user","parameters":[{"description":"User id of the user","required":true,"type":"string","name":"userid","in":"path"},{"schema":{"$ref":"#/definitions/SshKeyBaseProperties"},"required":true,"name":"SshKeyBaseProperties","in":"body"}],"tags":["System Administration","Configuration","Fabric","Nodes","User Management","Users"],"summary":"Remove SSH public key from authorized_keys file for node user","x-vmw-nsx-module":"NodeUsers","consumes":["application/json"],"operationId":"DeleteNodeUserSshKeyRemoveSshKey"}},"/upgrade/upgrade-unit-groups/{group-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UpgradeUnitGroup"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update the specified upgrade unit group. Removal of upgrade units from the\ngroup using this is not allowed. An error will be returned in that case.\n","parameters":[{"required":true,"type":"string","name":"group-id","in":"path"},{"schema":{"$ref":"#/definitions/UpgradeUnitGroup"},"required":true,"name":"UpgradeUnitGroup","in":"body"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Upgrade","Group"],"summary":"Update the upgrade unit group","x-vmw-nsx-module":"Upgrade","consumes":["application/json"],"operationId":"UpdateUpgradeUnitGroup"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"description":"Bad Request"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete the specified group.\nNOTE - A group can be deleted only if it is empty.\nIf user tries to delete a group containing one\nor more upgrade units, the operation will fail and an error\nwill be returned.\n","parameters":[{"required":true,"type":"string","name":"group-id","in":"path"}],"tags":["System Administration","Lifecycle Management","Upgrade","Group"],"summary":"Delete the upgrade unit group","x-vmw-nsx-module":"Upgrade","consumes":["application/json"],"operationId":"DeleteUpgradeUnitGroup"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UpgradeUnitGroup"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about a specific upgrade unit group in the\nupgrade plan. If request parameter summary is set to true, then\nonly count of upgrade units will be returned, upgrade units list\nwill be empty.\n","parameters":[{"required":true,"type":"string","name":"group-id","in":"path"},{"description":"Flag indicating whether to return the summary","default":false,"required":false,"in":"query","type":"boolean","name":"summary"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Upgrade","Group"],"summary":"Return upgrade unit group information","x-vmw-nsx-module":"Upgrade","consumes":["application/json"],"operationId":"GetUpgradeUnitGroup"}},"/upgrade/upgrade-unit-groups/{group-id}/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UpgradeUnitStatusListResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get upgrade status for upgrade units in the specified group. User can\nspecify whether to show only the upgrade units with errors.\n","parameters":[{"required":true,"type":"string","name":"group-id","in":"path"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Flag to indicate whether to return only upgrade units with errors","default":false,"required":false,"in":"query","type":"boolean","name":"has_errors"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Upgrade","Group"],"summary":"Get upgrade status for group","x-vmw-nsx-module":"Upgrade","consumes":["application/json"],"operationId":"GetUpgradeUnitGroupStatus"}},"/migration/grouped-feedback-requests":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/GroupedMigrationFeedbackRequestListResult"}},"401":{"description":"Unauthorized"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get feedback details of NSX-V to be migrated, grouped by feedback type.\n","parameters":[{"description":"Category on which feedback request should be filtered","required":false,"type":"string","name":"category","in":"query"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Id of the site in NSX-T Federation","required":false,"type":"string","name":"federation_site_id","in":"query"},{"description":"Hash based on which feedback request should be filtered","required":false,"type":"string","name":"hash","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"enum":["L2","L3_L7"],"description":"Network layer for which feedback is generated","required":false,"in":"query","type":"string","name":"network_layer"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"enum":["ALL","RESOLVED","UNRESOLVED"],"description":"Filter based on current state of the feedback request","default":"ALL","required":false,"in":"query","type":"string","name":"state"},{"description":"Sub category based on which feedback request should be filtered","required":false,"type":"string","name":"sub_category","in":"query"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Migration","Feedback"],"summary":"NSX-V feedback details","x-vmw-nsx-module":"Migration","consumes":["application/json"],"operationId":"GetGroupedFeedbackRequests"}},"/node/tasks":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ApplianceManagementTaskListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"List appliance management tasks","parameters":[{"description":"Fields to include in query results","type":"string","name":"fields","in":"query"},{"pattern":"/^(=|!=|~|!~)?.+$/","description":"Request method(s) to include in query result","type":"string","name":"request_method","in":"query"},{"pattern":"/^(=|!=|~|!~)?.+$/","description":"Request URI path(s) to include in query result","type":"string","name":"request_path","in":"query"},{"pattern":"/^(=|!=|~|!~)?.+$/","description":"Request URI(s) to include in query result","type":"string","name":"request_uri","in":"query"},{"pattern":"/^(=|!=|~|!~)?.+$/","description":"Status(es) to include in query result","type":"string","name":"status","in":"query"},{"pattern":"/^(=|!=|~|!~)?.+$/","description":"Names of users to include in query result","type":"string","name":"user","in":"query"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","Tasks"],"summary":"List appliance management tasks","x-vmw-nsx-module":"ApplianceManagementTaskModule","consumes":["application/json"],"operationId":"ListApplianceManagementTasks"}},"/fabric/compute-managers/{compute-manager-id}/state":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ConfigurationState"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get the realized state of a compute manager","parameters":[{"required":true,"type":"string","name":"compute-manager-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Compute Managers"],"summary":"Get the realized state of a compute manager","x-vmw-nsx-module":"InventoryCmObj","consumes":["application/json"],"operationId":"GetComputeManagerState"}},"/loadbalancer/pools":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/LbPool"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Create a load balancer pool.\n","parameters":[{"schema":{"$ref":"#/definitions/LbPool"},"required":true,"name":"LbPool","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Create a load balancer pool","x-vmw-nsx-module":"LoadBalancer","consumes":["application/json"],"operationId":"CreateLoadBalancerPool"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LbPoolListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Retrieve a paginated list of load balancer pools.\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Retrieve a paginated list of load balancer pools","x-vmw-nsx-module":"LoadBalancer","consumes":["application/json"],"operationId":"ListLoadBalancerPools"}},"/notification-watchers/{watcher-id}/notifications?action=delete_uri_filters":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NotificationsList"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete uri filters for the specified watcher ID.","parameters":[{"required":true,"type":"string","name":"watcher-id","in":"path"},{"schema":{"$ref":"#/definitions/Notification"},"required":true,"name":"Notification","in":"body"}],"produces":["application/json"],"tags":["System Administration","Monitoring","Notifications"],"summary":"Delete uri filters for the specified watcher ID.","x-vmw-nsx-module":"NfwConfig","consumes":["application/json"],"operationId":"DeleteUriFilters"}},"/service-configs":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/ServiceConfig"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Creates a new service config that can group profiles and configs\n","parameters":[{"schema":{"$ref":"#/definitions/ServiceConfig"},"required":true,"name":"ServiceConfig","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Security","Service Configuration"],"summary":"Create service config","x-vmw-nsx-module":"ServiceConfig","consumes":["application/json"],"operationId":"CreateServiceConfig"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ServiceConfigListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"List of all service configs.\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"description":"Fetch ServiceConfig for the given attribute profile_type","required":false,"type":"string","name":"profile_type","in":"query"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Security","Service Configuration"],"summary":"List service configs","x-vmw-nsx-module":"ServiceConfig","consumes":["application/json"],"operationId":"ListServiceConfigs"}},"/upgrade/pre-upgrade-checks?format=csv":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UpgradeCheckCsvListResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns pre-upgrade checks in csv format\n","produces":["text/csv"],"tags":["System Administration","Lifecycle Management","Upgrade","Plan"],"summary":"Returns pre-upgrade checks in csv format","x-vmw-nsx-module":"Upgrade","consumes":["application/json"],"operationId":"GetAllPreUpgradeChecksInCsvFormat"}},"/node/services/migration-coordinator?action=restart":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the migration coordinator service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Migration Coordinator Service"],"summary":"Restart, start or stop the migration coordinator service","x-vmw-nsx-module":"NodeMigrationCoordinatorService","consumes":["application/json"],"operationId":"CreateMigrationCoordinatorServiceActionRestart"}},"/migration/setup?action=addAlbInfo":{"put":{"responses":{"200":{"description":"OK"},"401":{"description":"Unauthorized"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Add ALB endpoint details for non cross VC migration modes.\n","parameters":[{"schema":{"$ref":"#/definitions/AviEndPoint"},"required":true,"name":"AviEndPoint","in":"body"}],"tags":["System Administration","Lifecycle Management","Migration","Setup"],"summary":"Add ALB endpoint details for non cross VC migration modes.","x-vmw-nsx-module":"Migration","consumes":["application/json"],"operationId":"AddAlbInfo"}},"/trust-management/csrs-extended":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/Csr"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Creates a new certificate signing request (CSR) with selected extensions.\nA CSR is encrypted text that contains information about your organization\n(organization name, country, and so on), additional attributes as\nextensions, and your Web server's public key, which is a public certificate\nthe is generated on the server that can be used to forward this request\nto a certificate authority (CA). A private key is also usually created at\nthe same time as the CSR.\n","parameters":[{"schema":{"$ref":"#/definitions/CsrExt"},"required":true,"name":"CsrExt","in":"body"}],"produces":["application/json"],"tags":["System Administration","Settings","Certificates","CSR"],"summary":"Generate a New Certificate Signing Request with Extensions","x-vmw-nsx-module":"CertificateManager","consumes":["application/json"],"operationId":"GenerateCsrWithExtensions"}},"/logical-routers/{logical-router-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LogicalRouter"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Modifies the specified logical router. Modifiable attributes include the\ninternal_transit_network, external_transit_networks, and edge_cluster_id\n(for TIER0 routers).\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"schema":{"$ref":"#/definitions/LogicalRouter"},"required":true,"name":"LogicalRouter","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Logical Routers"],"summary":"Update a Logical Router","x-vmw-nsx-module":"LogicalRouter","consumes":["application/json"],"operationId":"UpdateLogicalRouter"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LogicalRouter"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about the specified logical router.","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Logical Routers"],"summary":"Read Logical Router","x-vmw-nsx-module":"LogicalRouter","consumes":["application/json"],"operationId":"ReadLogicalRouter"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Deletes the specified logical router. You must delete associated logical\nrouter ports before you can delete a logical router. Otherwise use force\ndelete which will delete all related ports and other entities associated\nwith that LR. To force delete logical router pass force=true in query param.\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"description":"Flag to specify whether to delete related logical switch ports","default":false,"required":false,"in":"query","type":"boolean","name":"cascade_delete_linked_ports"},{"default":false,"description":"Force delete the resource even if it is being used somewhere\n","type":"boolean","name":"force","in":"query"}],"tags":["Management Plane API","Networking","Logical Routing And Services","Logical Routers"],"summary":"Delete a Logical Router","x-vmw-nsx-module":"LogicalRouter","consumes":["application/json"],"operationId":"DeleteLogicalRouter"}},"/transport-nodes/{transport-node-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TransportNode"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Modifies the transport node information. The host_switch_name field\nmust match the host_switch_name value specified in the transport zone\n(API: transport-zones). You must create the associated uplink profile\n(API: host-switch-profiles) before you can specify an uplink_name here.\nIf the host is an ESX and has only one physical NIC being used by a vSphere\nstandard switch, TransportNodeUpdateParameters should be used to migrate\nthe management interface and the physical NIC into a logical switch that\nis in a transport zone this transport node will join or has already joined.\nIf the migration is already done, TransportNodeUpdateParameters can also be\nused to migrate the management interface and the physical NIC back to a\nvSphere standard switch.\nIn other cases, the TransportNodeUpdateParameters should NOT be used.\nWhen updating transport node you should follow pattern where you should\nfetch the existing transport node and then only modify the required\nproperties keeping other properties as is.\n\nIt also modifies attributes of node (host or edge).\n\nNote: Previous versions of NSX-T also used a property named\ntransport_zone_endpoints at TransportNode level. This property is\ndeprecated which creates some combinations of new client along with\nold client payloads. Examples [1] shows old/existing client\nrequest and response by populating transport_zone_endpoints property\nat TransportNode level. Example [2] shows TransportNode updating\nTransportNode from exmaple [1] request/response by adding a\nnew StandardHostSwitch by populating transport_zone_endpoints at\nStandardHostSwitch level. TransportNode level transport_zone_endpoints\nwill ONLY have TransportZoneEndpoints that were originally specified\nhere during create/update operation and does not include\nTransportZoneEndpoints that were directly specified at\nStandardHostSwitch level.\nThis api is now deprecated. Please use new api -\n/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/host-transport-nodes/<host-transport-node-id>\n","parameters":[{"required":true,"type":"string","name":"transport-node-id","in":"path"},{"schema":{"$ref":"#/definitions/TransportNode"},"required":true,"name":"TransportNode","in":"body"},{"description":"The network ids to which the ESX vmk interfaces will be migrated","required":false,"type":"string","name":"esx_mgmt_if_migration_dest","in":"query"},{"description":"The ESX vmk interfaces to migrate","required":false,"type":"string","name":"if_id","in":"query"},{"description":"IP Addresses to ping right after ESX vmk interfaces were migrated.","required":false,"type":"string","name":"ping_ip","in":"query"},{"description":"Whether to skip front-end validation for vmk/vnic/pnic migration","default":false,"required":false,"in":"query","type":"boolean","name":"skip_validation"},{"description":"The ESX vmk interfaces and/or VM NIC to migrate","required":false,"type":"string","name":"vnic","in":"query"},{"description":"The migration destinations of ESX vmk interfaces and/or VM NIC","required":false,"type":"string","name":"vnic_migration_dest","in":"query"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Transport Nodes"],"summary":"Update a Transport Node","x-vmw-nsx-module":"TransportNodeLcm","consumes":["application/json"],"operationId":"UpdateTransportNodeWithDeploymentInfo"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Deletes the specified transport node. Query param force can be used to\nforce delete the host nodes. Force deletion of edge and public cloud\ngateway nodes is not supported.\n\nIt also removes the specified node (host or edge) from system.\nIf unprepare_host option is set to false, then host will be deleted\nwithout uninstalling the NSX components from the host.\nThis api is now deprecated. Please use new api -\n/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/host-transport-nodes/<host-transport-node-id>\n","parameters":[{"required":true,"type":"string","name":"transport-node-id","in":"path"},{"default":false,"description":"Force delete the resource even if it is being used somewhere\n","type":"boolean","name":"force","in":"query"},{"description":"Uninstall NSX components from host while deleting","default":true,"required":false,"in":"query","type":"boolean","name":"unprepare_host"}],"tags":["System Administration","Configuration","Fabric","Nodes","Transport Nodes"],"summary":"Delete a Transport Node","x-vmw-nsx-module":"TransportNodeLcm","consumes":["application/json"],"operationId":"DeleteTransportNodeWithDeploymentInfo"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TransportNode"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about a specified transport node. This api is now deprecated. Please use new api - /infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/host-transport-nodes/<host-transport-node-id>","parameters":[{"required":true,"type":"string","name":"transport-node-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Transport Nodes"],"summary":"Get a Transport Node","x-vmw-nsx-module":"TransportNodeLcm","consumes":["application/json"],"operationId":"GetTransportNodeWithDeploymentInfo"}},"/logical-routers/{logical-router-id}/routing/bgp/neighbors/{neighbor-id}/advertised-routes?format=csv":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BgpNeighborRouteDetailsInCsvFormat"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns routes advertised by BGP neighbor from all edge transport\nnodes on which this neighbor is currently enabled in CSV format.\nIt always returns realtime response.\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"required":true,"type":"string","name":"neighbor-id","in":"path"}],"produces":["text/csv"],"tags":["Management Plane API","Networking","Logical Routing And Services","Logical Routers"],"summary":"Get BGP neighbor advertised routes in CSV format\n","x-vmw-nsx-module":"AggSvcLogicalRouter","consumes":["application/json"],"operationId":"GetBgpNeighborAdvertisedRoutesInCsvFormat"}},"/firewall/sections/{section-id}?action=lock":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FirewallSection"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"423":{"description":"Locked"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Lock a section.\n","parameters":[{"required":true,"type":"string","name":"section-id","in":"path"},{"schema":{"$ref":"#/definitions/FirewallSectionLock"},"required":true,"name":"FirewallSectionLock","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Firewall"],"summary":"Lock a section","x-vmw-nsx-module":"Firewall","consumes":["application/json"],"operationId":"LockSection"}},"/vpn/ipsec/local-endpoints/{ipsec-vpn-local-endpoint-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IPSecVPNLocalEndpoint"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Edit custom IPSec local endpoint.","parameters":[{"required":true,"type":"string","name":"ipsec-vpn-local-endpoint-id","in":"path"},{"schema":{"$ref":"#/definitions/IPSecVPNLocalEndpoint"},"required":true,"name":"IPSecVPNLocalEndpoint","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","VPN","IPSEC","Peer Endpoints"],"summary":"Edit custom IPSec local endpoint","x-vmw-nsx-module":"IPSecVPN","consumes":["application/json"],"operationId":"UpdateIPSecVPNLocalEndpoint"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IPSecVPNLocalEndpoint"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get custom IPSec local endpoint.","parameters":[{"required":true,"type":"string","name":"ipsec-vpn-local-endpoint-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","VPN","IPSEC","Peer Endpoints"],"summary":"Get custom IPSec local endpoint","x-vmw-nsx-module":"IPSecVPN","consumes":["application/json"],"operationId":"GetIPSecVPNLocalEndpoint"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete custom IPSec local endpoint.","parameters":[{"required":true,"type":"string","name":"ipsec-vpn-local-endpoint-id","in":"path"},{"default":false,"description":"Force delete the resource even if it is being used somewhere\n","type":"boolean","name":"force","in":"query"}],"tags":["Management Plane API","Networking","VPN","IPSEC","Peer Endpoints"],"summary":"Delete custom IPSec local endpoint","x-vmw-nsx-module":"IPSecVPN","consumes":["application/json"],"operationId":"DeleteIPSecVPNLocalEndpoint"}},"/ip-sets/{ip-set-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IPSet"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Updates the specified IPSet. Modifiable parameters include description,\ndisplay_name and ip_addresses.\n","parameters":[{"description":"IPSet Id","required":true,"type":"string","name":"ip-set-id","in":"path"},{"schema":{"$ref":"#/definitions/IPSet"},"required":true,"name":"IPSet","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Grouping Objects","IP Sets"],"summary":"Update IPSet","x-vmw-nsx-module":"IPSet","consumes":["application/json"],"operationId":"UpdateIPSet"},"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/IPAddressElement"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Add/Remove an individual IP address to an IPSet\n","parameters":[{"description":"IP Set Id","required":true,"type":"string","name":"ip-set-id","in":"path"},{"schema":{"$ref":"#/definitions/IPAddressElement"},"required":true,"name":"IPAddressElement","in":"body"},{"enum":["add_ip","remove_ip"],"description":"Specifies addition or removal action","required":true,"in":"query","type":"string","name":"action"}],"produces":["application/json"],"tags":["Management Plane API","Grouping Objects","IP Sets"],"summary":"Add a IP address to a IPSet","x-vmw-nsx-module":"IPSet","consumes":["application/json"],"operationId":"AddRemoveIPAddress"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"409":{"description":"Conflict"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Deletes the specified IPSet. By default, if the IPSet is added to an\nNSGroup, it won't be deleted. In such situations, pass \"force=true\" as\nquery param to force delete the IPSet.\n","parameters":[{"description":"IPSet Id","required":true,"type":"string","name":"ip-set-id","in":"path"},{"default":false,"description":"Force delete the resource even if it is being used somewhere\n","type":"boolean","name":"force","in":"query"}],"tags":["Management Plane API","Grouping Objects","IP Sets"],"summary":"Delete IPSet","x-vmw-nsx-module":"IPSet","consumes":["application/json"],"operationId":"DeleteIPSet"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IPSet"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about the specified IPSet\n","parameters":[{"description":"IPSet Id","required":true,"type":"string","name":"ip-set-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Grouping Objects","IP Sets"],"summary":"Read IPSet","x-vmw-nsx-module":"IPSet","consumes":["application/json"],"operationId":"ReadIPSet"}},"/tasks":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TaskListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get information about all tasks","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"description":"Request URI(s) to include in query result","type":"string","name":"request_uri","in":"query"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"description":"Status(es) to include in query result","type":"string","name":"status","in":"query"},{"description":"Names of users to include in query result","type":"string","name":"user","in":"query"}],"produces":["application/json"],"tags":["System Administration","Configuration","NSX Managers","API Services","Task Management"],"summary":"Get information about all tasks","x-vmw-nsx-module":"Tasks","consumes":["application/json"],"operationId":"ListTasks"}},"/trust-management/principal-identities/with-certificate":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/PrincipalIdentity"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Create a principal identity with a new, unused, certificate.\nThe combination name and node_id needs to be unique across token-based and\ncertificate-based principal identities.\n","parameters":[{"schema":{"$ref":"#/definitions/PrincipalIdentityWithCertificate"},"required":true,"name":"PrincipalIdentityWithCertificate","in":"body"}],"produces":["application/json"],"tags":["System Administration","Settings","User Management","Principal Identity"],"summary":"Register a name-certificate combination.","x-vmw-nsx-module":"CertificateManager","consumes":["application/json"],"operationId":"RegisterPrincipalIdentityWithCertificate"}},"/logical-ports/{lport-id}/mac-table":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LogicalPortMacAddressListResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns MAC table of a specified logical port. If the target transport node id is not provided,\nthe NSX manager will ask the controller for the transport node where the logical port is located.\nThe query parameter \"source=cached\" is not supported. MAC table retrieval is not supported on\nlogical ports that are attached to a logical router.\n","parameters":[{"required":true,"type":"string","name":"lport-id","in":"path"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"},{"description":"TransportNode Id","required":false,"type":"string","name":"transport_node_id","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Switching","Logical Switch Ports"],"summary":"Get MAC table of a logical port with a given port id (lport-id)","x-vmw-nsx-module":"AggSvcLogicalPort","consumes":["application/json"],"operationId":"GetLogicalPortMacTable"}},"/logical-routers/{logical-router-id}/routing/advertisement/rules":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AdvertiseRuleList"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Modifies the advertisement rules on the specified logical\nrouter. The PUT request must include all the rules with the networks parameter. Modifiable\nparameters are networks, display_name, and description. Set the rules list to empty to delete/clear all rules.\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"schema":{"$ref":"#/definitions/AdvertiseRuleList"},"required":true,"name":"AdvertiseRuleList","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Routing Configuration"],"summary":"Update the Advertisement Rules on a Logical Router","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"UpdateAdvertiseRuleList"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AdvertiseRuleList"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the advertisement rule list for the specified\nTIER1 logical router.\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Routing Configuration"],"summary":"Read the Advertisement Rules on a Logical Router","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"ReadAdvertiseRuleList"}},"/logical-routers/{logical-router-id}/service-cluster/state":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LogicalServiceRouterClusterState"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Return realized state information of a logical service router cluster.\nAny configuration update that affects the logical service router cluster can use\nthis API to get its realized state by passing a request_id returned by the\nconfiguration change operation. e.g. Update configuration of nat, bgp, bfd, etc.\n\nWhat is a Service Router?\nWhen a service cannot be distributed is enabled on a Logical Router, a Service Router (SR) is instantiated.\nSome examples of services that are not distributed are NAT, DHCP server, Metadata Proxy, Edge Firewall,\nLoad Balancer and so on.\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"name":"barrier_id","format":"int64","required":false,"minimum":0,"in":"query","type":"integer"},{"description":"Realization request ID","required":false,"type":"string","name":"request_id","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Logical Routers"],"summary":"Get the Realized State of a Logical Service Router Cluster","x-vmw-nsx-module":"LogicalRouter","consumes":["application/json"],"operationId":"GetLogicalServiceRouterClusterState"}},"/logical-routers/{logical-router-id}/routing/routing-table?format=csv":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LogicalRouterRouteTableInCsvFormat"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the route table in CSV format for the logical router on a node of the given\ntransport-node-id. Query parameter \"transport_node_id=<transport-node-id>\" is required.\nTo filter the result by network address, paramter \"network_prefix=<a.b.c.d/mask>\"\nneeds to be specified.\nTo filter the result by route source, parameter \"route_source=<source_type>\" needs to be specified\nwhere source_type can be BGP, STATIC, CONNECTED, NSX_STATIC, TIER1_NAT or TIER0_NAT.\nIt is also possible to filter the RIB table using both network address and\nroute source filter together.\nQuery parameter \"source=realtime\" is the only supported source.\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"description":"IPAddress or CIDR Block","format":"address-or-cidr-block","required":false,"in":"query","type":"string","name":"network_prefix"},{"enum":["BGP","STATIC","CONNECTED","OSPF"],"description":"Route source filter parameter","required":false,"in":"query","type":"string","name":"route_source"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"},{"description":"TransportNode Id","required":true,"type":"string","name":"transport_node_id","in":"query"},{"enum":["DEFAULT","INTER_SR"],"description":"VRF filter parameter","required":false,"in":"query","type":"string","name":"vrf_table"}],"produces":["text/csv"],"tags":["Management Plane API","Networking","Logical Routing And Services","Logical Routers"],"summary":"Get RIB table on a specified node for a logical router","x-vmw-nsx-module":"AggSvcLogicalRouter","consumes":["application/json"],"operationId":"GetLogicalRouterRoutingTableInCsvFormat"}},"/trust-management/crl-distribution-points/{crl-distribution-point-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/CrlDistributionPoint"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update CrlDistributionPoint with <crl-distribution-point-id>\nThis allows updating the ManagedResource fields.\n","parameters":[{"required":true,"type":"string","name":"crl-distribution-point-id","in":"path"},{"schema":{"$ref":"#/definitions/CrlDistributionPoint"},"required":true,"name":"CrlDistributionPoint","in":"body"}],"produces":["application/json"],"tags":["System Administration","Settings","Certificates","CRL"],"summary":"Update CrlDistributionPoint with <crl-distribution-point-id>\nThis allows updating the ManagedResource fields.\n","x-vmw-nsx-module":"CertificateManager","consumes":["application/json"],"operationId":"UpdateCrlDistributionPoint"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete a CrlDistributionPoint. It does not delete the actual CRL.\n","parameters":[{"description":"Unique id of the CrlDistributionPoint to delete","required":true,"type":"string","name":"crl-distribution-point-id","in":"path"}],"tags":["System Administration","Settings","Certificates","CRL"],"summary":"Delete a CrlDistributionPoint","x-vmw-nsx-module":"CertificateManager","consumes":["application/json"],"operationId":"DeleteCrlDistributionPoint"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/CrlDistributionPoint"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Return the CrlDistributionPoint with <crl-distribution-point-id>","parameters":[{"required":true,"type":"string","name":"crl-distribution-point-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Settings","Certificates","CRL"],"summary":"Return the CrlDistributionPoint with <crl-distribution-point-id>","x-vmw-nsx-module":"CertificateManager","consumes":["application/json"],"operationId":"GetCrlDistributionPoint"}},"/transport-nodes":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/TransportNode"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Transport nodes are hypervisor hosts and NSX Edges that will participate\nin an NSX-T overlay. For a hypervisor host, this means that it hosts\nVMs that will communicate over NSX-T logical switches. For NSX Edges,\nthis means that it will have logical router uplinks and downlinks.\n\nThis API creates transport node for a host node (hypervisor) or edge node\n(router) in the transport network.\n\nWhen you run this command for a host, NSX Manager attempts to install the\nNSX kernel modules, which are packaged as VIB, RPM, or DEB files. For the\ninstallation to succeed, you must provide the host login credentials and the\nhost thumbprint.\n\nTo get the ESXi host thumbprint, SSH to the host and run the\nopenssl x509 -in /etc/vmware/ssl/rui.crt -fingerprint -sha256 -noout\ncommand.\n\nTo generate host key thumbprint using SHA-256 algorithm please follow the\nsteps below.\n\nLog into the host, making sure that the connection is not vulnerable to a\nman in the middle attack. Check whether a public key already exists.\nHost public key is generally located at '/etc/ssh/ssh_host_rsa_key.pub'.\nIf the key is not present then generate a new key by running the following\ncommand and follow the instructions.\n\nssh-keygen -t rsa\n\nNow generate a SHA256 hash of the key using the following command. Please\nmake sure to pass the appropriate file name if the public key is stored with\na different file name other than the default 'id_rsa.pub'.\n\nawk '{print $2}' id_rsa.pub | base64 -d | sha256sum -b | sed 's/ .*$//' | xxd -r -p | base64\nThis api is deprecated as part of FN+TN unification. Please use Transport Node API\nto install NSX components on a node.\n\nAdditional documentation on creating a transport node can be found\nin the NSX-T Installation Guide.\n\nIn order for the transport node to forward packets,\nthe host_switch_spec property must be specified.\n\nHost switches (called bridges in OVS on KVM hypervisors) are the\nindividual switches within the host virtual switch. Virtual machines\nare connected to the host switches.\n\nWhen creating a transport node, you need to specify if the host switches\nare already manually preconfigured on the node, or if NSX should create\nand manage the host switches. You specify this choice by the type\nof host switches you pass in the host_switch_spec property of the\nTransportNode request payload.\n\nFor a KVM host, you can preconfigure the host switch, or you can have\nNSX Manager perform the configuration. For an ESXi host or NSX Edge\nnode, NSX Manager always configures the host switch.\n\nTo preconfigure the host switches on a KVM host, pass an array\nof PreconfiguredHostSwitchSpec objects that describes those host\nswitches. In the current NSX-T release, only one prefonfigured host\nswitch can be specified. See the PreconfiguredHostSwitchSpec schema\ndefinition for documentation on the properties that must be provided.\nPreconfigured host switches are only supported on KVM hosts, not on\nESXi hosts or NSX Edge nodes.\n\nTo allow NSX to manage the host switch configuration on KVM hosts,\nESXi hosts, or NSX Edge nodes, pass an array of StandardHostSwitchSpec\nobjects in the host_switch_spec property, and NSX will automatically\ncreate host switches with the properties you provide. In the current\nNSX-T release, up to 16 host switches can be automatically managed.\nSee the StandardHostSwitchSpec schema definition for documentation on\nthe properties that must be provided.\n\nNote: Previous versions of NSX-T also used a property named\ntransport_zone_endpoints at TransportNode level. This property is\ndeprecated which creates some combinations of new client along with\nold client payloads. Examples [1] & [2] show old/existing client\nrequest and response by populating transport_zone_endpoints property\nat TransportNode level. Example [3] shows TransportNode creation\nrequest/response by populating transport_zone_endpoints property\nat StandardHostSwitch level and other new properties.\n\nThe request should either provide node_deployement_info or node_id.\n\nIf the host node (hypervisor) or edge node (router) is already added in\nsystem then it can be converted to transport node by providing node_id in\nrequest.\n\nIf host node (hypervisor) or edge node (router) is not already present in\nsystem then information should be provided under node_deployment_info.\nThis api is now deprecated. Please use new api -\n/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/host-transport-nodes/<host-transport-node-id>\n","parameters":[{"schema":{"$ref":"#/definitions/TransportNode"},"required":true,"name":"TransportNode","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Transport Nodes"],"summary":"Create a Transport Node","x-vmw-nsx-module":"TransportNodeLcm","consumes":["application/json"],"operationId":"CreateTransportNodeWithDeploymentInfo"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TransportNodeListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about all transport nodes along with underlying host or\nedge details. A transport node is a host or edge that contains hostswitches.\nA hostswitch can have virtual machines connected to them.\n\nBecause each transport node has hostswitches, transport nodes can also have\nvirtual tunnel endpoints, which means that they can be part of the overlay.\nThis api is now deprecated. Please use new api -\n/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/host-transport-nodes\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"maintenance mode flag","required":false,"type":"boolean","name":"in_maintenance_mode","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"node identifier","required":false,"type":"string","name":"node_id","in":"query"},{"description":"Fabric node IP address","required":false,"type":"string","name":"node_ip","in":"query"},{"description":"a list of fabric node types separated by comma or a single type","required":false,"type":"string","name":"node_types","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"description":"Transport zone identifier","required":false,"type":"string","name":"transport_zone_id","in":"query"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Transport Nodes"],"summary":"List Transport Nodes","x-vmw-nsx-module":"TransportNodeLcm","consumes":["application/json"],"operationId":"ListTransportNodesWithDeploymentInfo"}},"/node/services/controller":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read controller service properties","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Controller Service"],"summary":"Read controller service properties","x-vmw-nsx-module":"NodeControllerServerService","consumes":["application/json"],"operationId":"ReadControllerServerService"}},"/transport-nodes/{transport-node-id}/network/interfaces/{interface-id}/stats":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeInterfaceStatisticsProperties"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"On the specified interface, returns the number of received (rx), transmitted\n(tx), and dropped packets; the number of bytes and errors received and\ntransmitted on the interface; and the number of detected collisions.\n","parameters":[{"required":true,"type":"string","name":"transport-node-id","in":"path"},{"required":true,"type":"string","name":"interface-id","in":"path"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Transport Node Interfaces"],"summary":"Read the NSX Manager's Network Interface Statistics","x-vmw-nsx-module":"ApplianceStats","consumes":["application/json"],"operationId":"ReadTransportNodeInterfaceStatistics"}},"/fabric/compute-collections/{cc-ext-id}/member-status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/HostNodeStatusListResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get status of member host nodes of the compute-collection. Only nsx prepared host nodes in the specified compute-collection are included in the response. cc-ext-id should be of type VC_Cluster.","parameters":[{"required":true,"type":"string","name":"cc-ext-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Compute Collections"],"summary":"Get status of member host nodes of the compute-collection. Only nsx prepared host nodes in the specified compute-collection are included in the response. cc-ext-id should be of type VC_Cluster.","x-vmw-nsx-module":"ComputeCollectionDeployment","consumes":["application/json"],"operationId":"GetHostNodeStatusOnComputeCollection"}},"/migration/nodes":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeInfoListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get list of nodes. If request parameter component type is specified, then\nall nodes for that component will be returned. If request parameter component\nversion is specified, then all nodes at that version will be returned.\n","parameters":[{"description":"Component type based on which nodes will be filtered","required":false,"type":"string","name":"component_type","in":"query"},{"description":"Component version based on which nodes will be filtered","required":false,"type":"string","name":"component_version","in":"query"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Migration","Nodes"],"summary":"Get list of nodes across all types","x-vmw-nsx-module":"Migration","consumes":["application/json"],"operationId":"GetMigrationNodes"}},"/intrusion-services/affected-vms":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IdsVmList"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"description":"Bad Request"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get the list of the VMs affected pertaining to a specific\nsignature.\n","parameters":[{"schema":{"$ref":"#/definitions/IDSEventDataRequest"},"required":true,"name":"IDSEventDataRequest","in":"body"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Security","Intrusion Services","Dashboard"],"summary":"Get the list of the VMs affected for that signature","x-vmw-nsx-module":"IDSMetrics","consumes":["application/json"],"operationId":"GetAffectedVms"}},"/node/users?action=reset_own_password":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"409":{"description":"Conflict"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"description":"Service Unavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Enables a user to reset their own password.\n","parameters":[{"schema":{"$ref":"#/definitions/ResetNodeUserOwnPasswordProperties"},"required":true,"name":"ResetNodeUserOwnPasswordProperties","in":"body"}],"tags":["System Administration","Configuration","Fabric","Nodes","User Management","Users"],"summary":"Reset a user's own password. Requires current password","x-vmw-nsx-module":"NodeUsersManagerNodeType","consumes":["application/json"],"operationId":"ResetNodeUserOwnPasswordResetOwnPassword"}},"/intrusion-services/profiles/{ids-profile-id}":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IDSProfile"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about the specified IDSProfile.\n","parameters":[{"description":"IDSProfile Id","required":true,"type":"string","name":"ids-profile-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Security","Intrusion Services","IDS Profiles"],"summary":"Get IDSProfile","x-vmw-nsx-module":"IDSProfile","consumes":["application/json"],"operationId":"GetIDSProfile"}},"/configs/central-config/node-config-profiles/{profile-id}":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/CentralNodeConfigProfile"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns properties in specified Central Node Config profile. Sensitive data\n(like SNMP v2c community strings) are included only if query parameter\n\"show_sensitive_data\" is true.\n","parameters":[{"description":"Central Node Config profile id","required":true,"type":"string","name":"profile-id","in":"path"},{"description":"Show sensitive data in Central Node Config profile","default":false,"required":false,"in":"query","type":"boolean","name":"show_sensitive_data"}],"produces":["application/json"],"tags":["System Administration","Configuration","Global Configurations"],"summary":"Read Central Node Config profile","x-vmw-nsx-module":"CentralConfig","consumes":["application/json"],"operationId":"ReadCentralNodeConfigProfile"}},"/logical-routers/{logical-router-id}/routing/bgp/communty-lists/{community-list-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BGPCommunityList"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update a specific BGP community list from a Logical Router\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"required":true,"type":"string","name":"community-list-id","in":"path"},{"schema":{"$ref":"#/definitions/BGPCommunityList"},"required":true,"name":"BGPCommunityList","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Routing Configuration"],"summary":"Update a specific BGP community list from a logical router","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"UpdateBGPCommunityListOld"}},"/upgrade/plan?action=upgrade_selected_units":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"409":{"description":"Conflict"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Upgrades, Resumes the upgrade of a selected set of units.\n","parameters":[{"schema":{"$ref":"#/definitions/UpgradeUnitList"},"required":true,"name":"UpgradeUnitList","in":"body"}],"tags":["System Administration","Lifecycle Management","Upgrade","Plan"],"summary":"Upgrade selected units","x-vmw-nsx-module":"Upgrade","consumes":["application/json"],"operationId":"UpgradeSelectedUnits"}},"/trust-management/token-principal-identities":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/TokenBasedPrincipalIdentity"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Register a principal identity that is going to be authenticated through a token.\nThe combination name and node_id needs to be unique across token-based and\ncertificate-based principal identities.\n","parameters":[{"schema":{"$ref":"#/definitions/TokenBasedPrincipalIdentity"},"required":true,"name":"TokenBasedPrincipalIdentity","in":"body"}],"produces":["application/json"],"tags":["System Administration","Settings","User Management","Principal Identity"],"summary":"Register a token-based principal identity.","x-vmw-nsx-module":"CertificateManager","consumes":["application/json"],"operationId":"RegisterTokenBasedPrincipalIdentity"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TokenBasedPrincipalIdentityListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Return the list of token-based principal identities. | These don't have certificate or role information.","produces":["application/json"],"tags":["System Administration","Settings","User Management","Principal Identity"],"summary":"Return the list of token-based principal identities. | These don't have certificate or role information.","x-vmw-nsx-module":"CertificateManager","consumes":["application/json"],"operationId":"ListTokenBasedPrincipalIdentities"}},"/node/services/nsx-upgrade-agent":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read NSX upgrade Agent service properties","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","Upgrade Agent"],"summary":"Read NSX upgrade Agent service properties","x-vmw-nsx-module":"NodeNsxUpgradeAgent","consumes":["application/json"],"operationId":"ReadNsxUpgradeAgentService"}},"/dhcp/relays":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/DhcpRelayService"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Creates a dhcp relay service.\n","parameters":[{"schema":{"$ref":"#/definitions/DhcpRelayService"},"required":true,"name":"DhcpRelayService","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","DHCP Relay"],"summary":"Create a DHCP Relay Service","x-vmw-nsx-module":"DhcpRelay","consumes":["application/json"],"operationId":"CreateDhcpRelay"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DhcpRelayServiceListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about all configured dhcp relay services.\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","DHCP Relay"],"summary":"List all DHCP Relay Services","x-vmw-nsx-module":"DhcpRelay","consumes":["application/json"],"operationId":"ListDhcpRelays"}},"/node/services/node-mgmt/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read appliance management service status","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","Node Management"],"summary":"Read appliance management service status","x-vmw-nsx-module":"NodeApplianceManagementService","consumes":["application/json"],"operationId":"ReadApplianceManagementServiceStatus"}},"/manual-health-checks":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/ManualHealthCheck"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"description":"Bad Request"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Create a new manual health check request with essential properties. It's\ndisallowed to create new one until the count of in-progress manual health\ncheck is less than 50. A manual health check will be deleted automatically\nafter finished for 24 hours.\n","parameters":[{"schema":{"$ref":"#/definitions/ManualHealthCheck"},"required":true,"name":"ManualHealthCheck","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Troubleshooting And Monitoring","Healthcheck"],"summary":"Create a new manual health check request","x-vmw-nsx-module":"HealthCheck","consumes":["application/json"],"operationId":"CreateManualHealthCheck"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ManualHealthCheckListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Query manual health checks with list parameters.\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Troubleshooting And Monitoring","Healthcheck"],"summary":"List manual health checks","x-vmw-nsx-module":"HealthCheck","consumes":["application/json"],"operationId":"ListManualHealthChecks"}},"/cluster/nodes/{node-id}":{"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Removes the specified controller from the NSX cluster. Before you can\nremove a controller from the cluster, you must shut down the controller\nservice with the \"stop service controller\" command.\nDeprecated. Use POST /cluster/<node-id>?action=remove_node\nto detach a node from cluster. The controller is removed with the node.\n","parameters":[{"required":true,"type":"string","name":"node-id","in":"path"}],"tags":["System Administration","Configuration","NSX Managers","Clusters","Cluster Configuration"],"summary":"Remove a controller from the cluster","x-vmw-nsx-module":"ClusterManagement","consumes":["application/json"],"operationId":"DeleteClusterNodeConfig"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ClusterNodeConfig"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about the specified NSX cluster node.\nDeprecated. Use GET /cluster/<node-id> to get cluster node configuration.\n","parameters":[{"required":true,"type":"string","name":"node-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","NSX Managers","Clusters","Cluster Configuration"],"summary":"Read Cluster Node Configuration","x-vmw-nsx-module":"ClusterManagement","consumes":["application/json"],"operationId":"ReadClusterNodeConfig"}},"/migration/setup":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MigrationSetupInfo"}},"401":{"description":"Unauthorized"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Provide setup details of NSX-V to be migrated.\n","parameters":[{"schema":{"$ref":"#/definitions/MigrationSetupInfo"},"required":true,"name":"MigrationSetupInfo","in":"body"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Migration","Setup"],"summary":"NSX-V setup details","x-vmw-nsx-module":"Migration","consumes":["application/json"],"operationId":"UpdateNsxvSetupDetails"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MigrationSetupInfo"}},"401":{"description":"Unauthorized"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get setup details of NSX-V to be migrated.\n","produces":["application/json"],"tags":["System Administration","Lifecycle Management","Migration","Setup"],"summary":"NSX-V setup details","x-vmw-nsx-module":"Migration","consumes":["application/json"],"operationId":"GetNsxvSetupDetails"}},"/node/services/ntp?action=stop":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the NTP service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","NTP"],"summary":"Restart, start or stop the NTP service","x-vmw-nsx-module":"NodeNTPService","consumes":["application/json"],"operationId":"CreateNTPServiceActionStop"}},"/node/services/syslog?action=restart":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the syslog service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","Syslog"],"summary":"Restart, start or stop the syslog service","x-vmw-nsx-module":"NodeSyslogService","consumes":["application/json"],"operationId":"CreateSyslogServiceActionRestart"}},"/alarms":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AlarmsListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns a list of all Alarms currently known to the system.","parameters":[{"description":"Timestamp in milliseconds since epoch","format":"int64","required":false,"in":"query","type":"integer","name":"after"},{"description":"Timestamp in milliseconds since epoch","format":"int64","required":false,"in":"query","type":"integer","name":"before"},{"description":"Cursor for pagination","required":false,"type":"string","name":"cursor","in":"query"},{"description":"Event Type Filter","required":false,"type":"string","name":"event_type","in":"query"},{"description":"Feature Name","required":false,"type":"string","name":"feature_name","in":"query"},{"description":"Alarm ID","required":false,"type":"string","name":"id","in":"query"},{"description":"Intent Path for entity ID","required":false,"type":"string","name":"intent_path","in":"query"},{"description":"Node ID","required":false,"type":"string","name":"node_id","in":"query"},{"description":"Node Resource Type","required":false,"type":"string","name":"node_resource_type","in":"query"},{"description":"Page Size for pagination","format":"int64","required":false,"in":"query","type":"integer","name":"page_size"},{"description":"Severity","required":false,"type":"string","name":"severity","in":"query"},{"description":"Represents order of sorting the values","default":true,"required":false,"in":"query","type":"boolean","name":"sort_ascending"},{"description":"Key for sorting on this column","required":false,"type":"string","name":"sort_by","in":"query"},{"description":"Status","required":false,"type":"string","name":"status","in":"query"}],"produces":["application/json"],"tags":["System Administration","Monitoring","Alarms And Events"],"summary":"Get the list of all Alarms currently known to the system.","x-vmw-nsx-module":"Monitoring","consumes":["application/json"],"operationId":"GetAlarms"}},"/node/services/ui-service?action=start":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, Start and Stop the ui service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","User Interface Service"],"summary":"Restart, Start and Stop the ui service","x-vmw-nsx-module":"NodeUiServiceService","consumes":["application/json"],"operationId":"CreateNsxUiServiceServiceActionStart"}},"/idfw/nsgroup-vm-details/{group-id}":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IdfwNsgroupVmDetailListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get all Identity Firewall NSGroup VM details for a given NSGroup.","parameters":[{"required":true,"type":"string","name":"group-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Security","Identity Firewall","Realization Data"],"summary":"Get all IDFW NSGroup VM details for a given NSGroup","x-vmw-nsx-module":"IdentityFirewall","consumes":["application/json"],"operationId":"GetNsgroupVmDetails"}},"/transport-nodes/{target-node-id}/{target-uri}":{"put":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"504":{"description":"Gateway Timeout"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Invoke PUT request on target transport node","parameters":[{"description":"Target node UUID","required":true,"type":"string","name":"target-node-id","in":"path"},{"description":"URI of API to invoke on target node","required":true,"type":"string","name":"target-uri","in":"path"}],"tags":["System Administration","Configuration","Fabric","Nodes","Transport Nodes"],"summary":"Invoke PUT request on target transport node","x-vmw-nsx-module":"CentralApiModule","consumes":["application/json"],"operationId":"InvokePutTransportNodeCentralAPI"},"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"504":{"description":"Gateway Timeout"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Invoke POST request on target transport node","parameters":[{"description":"Target node UUID","required":true,"type":"string","name":"target-node-id","in":"path"},{"description":"URI of API to invoke on target node","required":true,"type":"string","name":"target-uri","in":"path"}],"tags":["System Administration","Configuration","Fabric","Nodes","Transport Nodes"],"summary":"Invoke POST request on target transport node","x-vmw-nsx-module":"CentralApiModule","consumes":["application/json"],"operationId":"InvokePostTransportNodeCentralAPI"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"504":{"description":"Gateway Timeout"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Invoke DELETE request on target transport node","parameters":[{"description":"Target node UUID","required":true,"type":"string","name":"target-node-id","in":"path"},{"description":"URI of API to invoke on target node","required":true,"type":"string","name":"target-uri","in":"path"}],"tags":["System Administration","Configuration","Fabric","Nodes","Transport Nodes"],"summary":"Invoke DELETE request on target transport node","x-vmw-nsx-module":"CentralApiModule","consumes":["application/json"],"operationId":"InvokeDeleteTransportNodeCentralAPI"},"get":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"504":{"description":"Gateway Timeout"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Invoke GET request on target transport node","parameters":[{"description":"Target node UUID","required":true,"type":"string","name":"target-node-id","in":"path"},{"description":"URI of API to invoke on target node","required":true,"type":"string","name":"target-uri","in":"path"}],"tags":["System Administration","Configuration","Fabric","Nodes","Transport Nodes"],"summary":"Invoke GET request on target transport node","x-vmw-nsx-module":"CentralApiModule","consumes":["application/json"],"operationId":"InvokeGetTransportNodeCentralAPI"}},"/licenses?action=delete":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"This will delete the license key identified in the request body\nby \"license_key\" and its properties from the system.\nAttempting to delete the last license key will result in an error.\n","parameters":[{"schema":{"$ref":"#/definitions/License"},"required":true,"name":"License","in":"body"}],"tags":["System Administration","Settings","Licenses"],"summary":"Remove a license","x-vmw-nsx-module":"License","consumes":["application/json"],"operationId":"DeleteLicenseKey"}},"/firewall/sections":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/FirewallSection"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Creates new empty firewall section in the system.\n","parameters":[{"schema":{"$ref":"#/definitions/FirewallSection"},"required":true,"name":"FirewallSection","in":"body"},{"in":"query","description":"Identifier of the anchor rule or section. This is a required field in case operation like 'insert_before' and 'insert_after'.","required":false,"maxLength":64,"type":"string","name":"id"},{"enum":["insert_top","insert_bottom","insert_after","insert_before"],"description":"Operation","default":"insert_top","required":false,"in":"query","type":"string","name":"operation"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Firewall"],"summary":"Create a New Empty Section","x-vmw-nsx-module":"Firewall","consumes":["application/json"],"operationId":"AddSection"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FirewallSectionListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"List all firewall section in paginated form. A default page size is limited\nto 1000 firewall sections. By default list of section is filtered by LAYER3\ntype.\n","parameters":[{"description":"AppliedTo's referenced by this section or section's Distributed Service Rules .","required":false,"type":"string","name":"applied_tos","in":"query"},{"description":"Limits results to sections having rules with specific Context Profiles.","type":"string","name":"context_profiles","in":"query"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Toggle to search with direct or indirect references.","default":false,"required":false,"in":"query","type":"boolean","name":"deep_search"},{"description":"Destinations referenced by this section's Distributed Service Rules .","required":false,"type":"string","name":"destinations","in":"query"},{"enum":["VIF","LOGICALROUTER","BRIDGEENDPOINT","DHCP_SERVICE","METADATA_PROXY","L2VPN_SESSION","NONE"],"description":"Type of attachment for logical port; for query only.","required":false,"in":"query","type":"string","name":"enforced_on"},{"enum":["NSGroup","LogicalSwitch","LogicalRouter","LogicalPort"],"description":"Resource type valid for use as AppliedTo filter in section API","required":false,"in":"query","type":"string","name":"exclude_applied_to_type"},{"description":"Limits results to sections having rules with specific Extended Sources.","type":"string","name":"extended_sources","in":"query"},{"enum":["FILTER","SEARCH"],"description":"Filter type","default":"FILTER","required":false,"in":"query","type":"string","name":"filter_type"},{"enum":["NSGroup","LogicalSwitch","LogicalRouter","LogicalPort"],"description":"Resource type valid for use as AppliedTo filter in section API","required":false,"in":"query","type":"string","name":"include_applied_to_type"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Limit results to sections which are locked/unlocked","required":false,"type":"boolean","name":"locked","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"description":"Return invalid references in results.","default":false,"required":false,"in":"query","type":"boolean","name":"search_invalid_references"},{"description":"Limit result to sections of a specific enforcement point","required":false,"type":"string","name":"search_scope","in":"query"},{"description":"NSService referenced by this section's Distributed Service Rules .","required":false,"type":"string","name":"services","in":"query"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"description":"Sources referenced by this section's Distributed Service Rules .","required":false,"type":"string","name":"sources","in":"query"},{"enum":["LAYER2","LAYER3"],"description":"Section Type","default":"LAYER3","required":false,"in":"query","type":"string","name":"type"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Firewall"],"summary":"List All Firewall Sections","x-vmw-nsx-module":"Firewall","consumes":["application/json"],"operationId":"ListSections"}},"/firewall/sections/{section-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FirewallSection"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Modifies the specified section, but does not modify the section's\nassociated rules. Simultaneous update (modify) operations on same section\nare not allowed to prevent overwriting stale contents to firewall section.\nIf a concurrent update is performed, HTTP response code 409 will be\nreturned to the client operating on stale data. That client should retrieve\nthe firewall section again and re-apply its update.\n","parameters":[{"required":true,"type":"string","name":"section-id","in":"path"},{"schema":{"$ref":"#/definitions/FirewallSection"},"required":true,"name":"FirewallSection","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Firewall"],"summary":"Update an Existing Section","x-vmw-nsx-module":"Firewall","consumes":["application/json"],"operationId":"UpdateSection"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FirewallSection"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about firewall section for the identifier.\n","parameters":[{"required":true,"type":"string","name":"section-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Firewall"],"summary":"Get an Existing Section","x-vmw-nsx-module":"Firewall","consumes":["application/json"],"operationId":"GetSection"},"delete":{"responses":{"200":{"description":"OK"},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Removes firewall section from the system. Firewall section with\nrules can only be deleted by passing \"cascade=true\" parameter.\n","parameters":[{"required":true,"type":"string","name":"section-id","in":"path"},{"description":"Flag to cascade delete of this object to all it's child objects.","default":false,"required":false,"in":"query","type":"boolean","name":"cascade"}],"tags":["Management Plane API","Security","Services","Firewall"],"summary":"Delete an Existing Section and Its Associated Rules","x-vmw-nsx-module":"Firewall","consumes":["application/json"],"operationId":"DeleteSection"}},"/node/services/http?action=restart":{"post":{"responses":{"202":{"description":"Accepted"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart the http service","tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","HTTP Service"],"summary":"Restart the http service","x-vmw-nsx-module":"NodeProxyService","consumes":["application/json"],"operationId":"CreateProxyServiceActionRestartRestart"}},"/nvds-urt/topology?action=apply":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UpgradeTopology"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Set VDS configuration and create it in vCenter","parameters":[{"schema":{"$ref":"#/definitions/UpgradeTopology"},"required":true,"name":"UpgradeTopology","in":"body"},{"description":"cluster identifier","required":false,"type":"string","name":"cluster_id","in":"query"},{"description":"Flag to indicate if use recommended topology got from the latest precheck","required":false,"type":"boolean","name":"use_recommended_topology_config","in":"query"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Transport Nodes"],"summary":"Set VDS configuration and create it in vCenter","x-vmw-nsx-module":"NvdsUpgradeReadinessCheck","consumes":["application/json"],"operationId":"SetTargetVdsTopology"}},"/firewall/sections/{section-id}/rules/{rule-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FirewallRule"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Modifies existing firewall rule in a firewall section. Updating firewall\nrule in a section modifies parent section entity and simultaneous update\n(modify) operations on same section are not allowed to prevent overwriting\nstale contents to firewall section. If a concurrent update is performed,\nHTTP response code 409 will be returned to the client operating on stale\ndata. That client should retrieve the firewall section again and re-apply\nits update.\n","parameters":[{"required":true,"type":"string","name":"section-id","in":"path"},{"required":true,"type":"string","name":"rule-id","in":"path"},{"schema":{"$ref":"#/definitions/FirewallRule"},"required":true,"name":"FirewallRule","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Firewall"],"summary":"Update an Existing Rule","x-vmw-nsx-module":"Firewall","consumes":["application/json"],"operationId":"UpdateRule"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FirewallRule"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Return existing firewall rule information in a firewall section.\n","parameters":[{"required":true,"type":"string","name":"section-id","in":"path"},{"required":true,"type":"string","name":"rule-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Firewall"],"summary":"Read an Existing Rule","x-vmw-nsx-module":"Firewall","consumes":["application/json"],"operationId":"GetRule"},"delete":{"responses":{"200":{"description":"OK"},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete existing firewall rule in a firewall section. Deleting firewall rule\nin a section modifies parent section and simultaneous update (modify)\noperations on same section are not allowed to prevent overwriting stale\ncontents to firewall section. If a concurrent update is performed, HTTP\nresponse code 409 will be returned to the client operating on stale data.\nThat client should retrieve the firewall section again and re-apply its\nupdate.\n","parameters":[{"required":true,"type":"string","name":"section-id","in":"path"},{"required":true,"type":"string","name":"rule-id","in":"path"}],"tags":["Management Plane API","Security","Services","Firewall"],"summary":"Delete an Existing Rule","x-vmw-nsx-module":"Firewall","consumes":["application/json"],"operationId":"DeleteRule"}},"/edge-clusters/{edge-cluster-id}/state":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EdgeClusterState"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Return realized state information of a edge cluster.\nAny configuration update that affects the edge cluster can use this API\nto get its realized state by passing a request_id returned by the\nconfiguration change operation. e.g. Update configuration of edge cluster.\n","parameters":[{"required":true,"type":"string","name":"edge-cluster-id","in":"path"},{"name":"barrier_id","format":"int64","required":false,"minimum":0,"in":"query","type":"integer"},{"description":"Realization request ID","required":false,"type":"string","name":"request_id","in":"query"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Edge Clusters","Edge Clusters"],"summary":"Get the Realized State of a Edge Cluster","x-vmw-nsx-module":"EdgeClusters","consumes":["application/json"],"operationId":"GetEdgeClusterState"}},"/logical-switches/{lswitch-id}/vtep-table?format=csv":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/VtepCsvListResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns virtual tunnel endpoint table of a specified logical switch in\nCSV format from the given transport node if a transport node id is\ngiven in the query parameter from the Central Controller Plane.\nThe query parameter \"source=cached\" is not supported.\n","parameters":[{"required":true,"type":"string","name":"lswitch-id","in":"path"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"},{"description":"TransportNode Id","required":false,"type":"string","name":"transport_node_id","in":"query"}],"produces":["text/csv"],"tags":["Management Plane API","Networking","Logical Switching","Logical Switches"],"summary":"Get virtual tunnel endpoint table for logical switch of the given\nID (lswitch-id)\n","x-vmw-nsx-module":"AggSvcLogicalSwitch","consumes":["application/json"],"operationId":"GetLogicalSwitchVtepTableInCsvFormat"}},"/migration/migration-unit-groups/{group-id}?action=reorder":{"post":{"responses":{"200":{"description":"OK"},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Reorder an migration unit group by placing it before/after\nthe specified migration unit group.\n","parameters":[{"required":true,"type":"string","name":"group-id","in":"path"},{"schema":{"$ref":"#/definitions/ReorderMigrationRequest"},"required":true,"name":"ReorderMigrationRequest","in":"body"}],"tags":["System Administration","Lifecycle Management","Migration","Group"],"summary":"Reorder migration unit group","x-vmw-nsx-module":"Migration","consumes":["application/json"],"operationId":"ReorderMigrationUnitGroup"}},"/node/services/manager?action=reset-manager-logging-levels":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Reset the logging levels to default values","tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Manager Service"],"summary":"Reset the logging levels to default values","x-vmw-nsx-module":"NodeProtonService","consumes":["application/json"],"operationId":"ResetProtonServiceLoggingLevelActionResetManagerLoggingLevels"}},"/fabric/container-network-policies":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ContainerNetworkPolicyListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about all network policies.","parameters":[{"description":"Identifier of the container cluster","required":false,"type":"string","name":"container_cluster_id","in":"query"},{"description":"Identifier of the container project","required":false,"type":"string","name":"container_project_id","in":"query"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"description":"Scope id for container cluster","required":false,"type":"string","name":"scope_id","in":"query"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Policy","Inventory","Containers","Container Clusters"],"summary":"Return the List of Container Network Policies","x-vmw-nsx-module":"InventoryContainerObj","consumes":["application/json"],"operationId":"ListContainerNetworkPolicies"}},"/ns-groups/{ns-group-id}/effective-ipset-members":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EffectiveMemberResourceListResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns effective IPSets which are members of the specified NSGroup.\nThis API is applicable only for NSGroups containing IPSet member type.\nFor NSGroups containing other member types,it returns an empty list.\n","parameters":[{"description":"NSGroup Id","required":true,"type":"string","name":"ns-group-id","in":"path"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Grouping Objects","NS Groups"],"summary":"Get Effective IPSets of the specified NSGroup.","x-vmw-nsx-module":"NSGroup","consumes":["application/json"],"operationId":"GetEffectiveIPSetMembers"}},"/idfw/user-session-data":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IdfwUserSessionDataAndMappings"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get user session data.","produces":["application/json"],"tags":["Management Plane API","Security","Identity Firewall","Realization Data"],"summary":"Get user session data","x-vmw-nsx-module":"IdentityFirewall","consumes":["application/json"],"operationId":"ListUserSessions"}},"/vpn/ipsec/services":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/IPSecVPNService"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Create VPN service for given logical router.","parameters":[{"schema":{"$ref":"#/definitions/IPSecVPNService"},"required":true,"name":"IPSecVPNService","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","VPN","IPSEC","Services"],"summary":"Create VPN service","x-vmw-nsx-module":"IPSecVPN","consumes":["application/json"],"operationId":"CreateIPSecVPNService"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IPSecVPNServiceListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get paginated list of all IPSec VPN services.","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","VPN","IPSEC","Services"],"summary":"Get IPSec VPN service list result","x-vmw-nsx-module":"IPSecVPN","consumes":["application/json"],"operationId":"ListIPSecVPNServices"}},"/migration/data/download":{"get":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Download the output data file generated during migration.\n","parameters":[{"description":"Id of the site in NSX-T Federation","required":false,"type":"string","name":"federation_site_id","in":"query"},{"enum":["VRA_INPUT","VRA_OUTPUT","EDGE_CUTOVER_MAPPING","BYOT_L3_MAPPING","AVI_LB_MAPPING"],"description":"Type of the Migration data file that needs to be downloaded.","required":true,"in":"query","type":"string","name":"file_type"}],"produces":["application/octet-stream"],"tags":["System Administration","Lifecycle Management","Migration","Stats"],"summary":"Download migration data","x-vmw-nsx-module":"Migration","consumes":["application/json"],"operationId":"DownloadMigrationData"}},"/logical-switches/{lswitch-id}/mac-table":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MacAddressListResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns MAC table of a specified logical switch from the given transport\nnode if a transport node id is given in the query parameter from the\nCentral Controller Plane.\nThe query parameter \"source=cached\" is not supported.\n","parameters":[{"required":true,"type":"string","name":"lswitch-id","in":"path"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"},{"description":"TransportNode Id","required":false,"type":"string","name":"transport_node_id","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Switching","Logical Switches"],"summary":"Get MAC Table for Logical Switch of the Given ID (lswitch-id)","x-vmw-nsx-module":"AggSvcLogicalSwitch","consumes":["application/json"],"operationId":"GetLogicalSwitchMacTable"}},"/pools/vni-pools/{pool-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/VniPool"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Updates the specified VNI pool. Modifiable parameters include description, display_name and ranges.\nRanges can be added, modified or deleted. Overlapping ranges are not allowed.\nOnly range end can be modified for any existing range.\nRange shrinking or deletion is not allowed if there are any allocated VNIs.\n","parameters":[{"description":"VNI pool ID","required":true,"type":"string","name":"pool-id","in":"path"},{"schema":{"$ref":"#/definitions/VniPool"},"required":true,"name":"VniPool","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Pool Management","VNI Pools"],"summary":"Update a VNI Pool","x-vmw-nsx-module":"Vnim","consumes":["application/json"],"operationId":"UpdateVNIPool"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/VniPool"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about the specified virtual network identifier (VNI) pool.\n","parameters":[{"description":"VNI pool ID","required":true,"type":"string","name":"pool-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Pool Management","VNI Pools"],"summary":"Read VNI Pool","x-vmw-nsx-module":"Vnim","consumes":["application/json"],"operationId":"ReadVNIPool"},"delete":{"responses":{"200":{"description":"OK"},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Deletes the given VNI pool.","parameters":[{"description":"VNI pool id","required":true,"type":"string","name":"pool-id","in":"path"},{"default":false,"description":"Force delete the resource even if it is being used somewhere\n","type":"boolean","name":"force","in":"query"}],"tags":["System Administration","Configuration","Fabric","Pool Management","VNI Pools"],"summary":"Delete a VNI Pool","x-vmw-nsx-module":"Vnim","consumes":["application/json"],"operationId":"DeleteVNIPool"}},"/automatic-health-checks/transport-zones/{transport-zone-id}":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AutomaticHealthCheck"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get health check performed by system automatically for specific transport\nzone.\n","parameters":[{"required":true,"type":"string","name":"transport-zone-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Monitoring","Health Checks"],"summary":"Get an automatic health check","x-vmw-nsx-module":"HealthCheck","consumes":["application/json"],"operationId":"GetAutomaticHealthCheck"}},"/serviceinsertion/status/{context-type}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ServiceInsertionStatus"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"description":"Bad Request"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update global ServiceInsertion status for a context","parameters":[{"required":true,"type":"string","name":"context-type","in":"path"},{"schema":{"$ref":"#/definitions/ServiceInsertionStatus"},"required":true,"name":"ServiceInsertionStatus","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Update global ServiceInsertion status for a context","x-vmw-nsx-module":"ServiceInsertionStatus","consumes":["application/json"],"operationId":"UpdateServiceInsertionStatus"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ServiceInsertionStatus"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get ServiceInsertion global status for a context","parameters":[{"required":true,"type":"string","name":"context-type","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Get ServiceInsertion global status for a context","x-vmw-nsx-module":"ServiceInsertionStatus","consumes":["application/json"],"operationId":"GetServiceInsertionStatus"}},"/node/services/policy?action=restart":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Policy Service"],"summary":"Restart, start or stop the service","x-vmw-nsx-module":"NodePolicyService","consumes":["application/json"],"operationId":"CreatePolicyServiceActionRestart"}},"/directory/domains":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/DirectoryDomain"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Create a directory domain","parameters":[{"schema":{"$ref":"#/definitions/DirectoryDomain"},"required":true,"name":"DirectoryDomain","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Directory Service","Domains"],"summary":"Create a directory domain","x-vmw-nsx-module":"DirectoryService","consumes":["application/json"],"operationId":"CreateDirectoryDomain"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DirectoryDomainListResults"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"List all configured domains","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["System Administration","Configuration","Directory Service","Domains"],"summary":"List all configured domains","x-vmw-nsx-module":"DirectoryService","consumes":["application/json"],"operationId":"ListDirectoryDomains"}},"/dhcp/servers/{server-id}/static-bindings/{binding-id}/state":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ConfigurationState"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Return realized state information of a dhcp static binding.\nAfter a dhcp static binding is created or updated, you can invoke this API to get\nthe realization information of the static binding.\n","parameters":[{"required":true,"type":"string","name":"server-id","in":"path"},{"required":true,"type":"string","name":"binding-id","in":"path"},{"name":"barrier_id","format":"int64","required":false,"minimum":0,"in":"query","type":"integer"},{"description":"Realization request ID","required":false,"type":"string","name":"request_id","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","DHCP"],"summary":"Get the realized state of a dhcp static binding","x-vmw-nsx-module":"Dhcp","consumes":["application/json"],"operationId":"GetDhcpStaticBindingState"}},"/migration/data":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MigrationDataInfo"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get information about the requested Migration Data file.","parameters":[{"description":"Id of the site in NSX-T Federation","required":false,"type":"string","name":"federation_site_id","in":"query"},{"enum":["VRA_INPUT","VRA_OUTPUT","EDGE_CUTOVER_MAPPING","BYOT_L3_MAPPING","AVI_LB_MAPPING"],"description":"Type of the Migration data file for which info is needed.","required":true,"in":"query","type":"string","name":"file_type"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Migration","Stats"],"summary":"Get Migration Data Info.","x-vmw-nsx-module":"Migration","consumes":["application/json"],"operationId":"GetMigrationDataInfo"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete the specified migration data file.\n","parameters":[{"description":"Id of the site in NSX-T Federation","required":false,"type":"string","name":"federation_site_id","in":"query"},{"enum":["VRA_INPUT","EDGE_CUTOVER_MAPPING","BYOT_L3_MAPPING","AVI_LB_MAPPING"],"description":"Type of the Migration data file that needs to be deleted.","required":true,"in":"query","type":"string","name":"file_type"}],"tags":["System Administration","Lifecycle Management","Migration","Stats"],"summary":"Delete the migration data file","x-vmw-nsx-module":"Migration","consumes":["application/json"],"operationId":"DeleteMigrationDataFile"}},"/dns/forwarders/{forwarder-id}?action=clear_cache":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Clear the current cache of the DNS forwarder.\n","parameters":[{"required":true,"type":"string","name":"forwarder-id","in":"path"}],"tags":["Management Plane API","Networking","Services","DNS"],"summary":"Clear the current cache of the DNS forwarder.","x-vmw-nsx-module":"DnsForwarder","consumes":["application/json"],"operationId":"ClearDnsForwarderCache"}},"/node/services/ssh/notify_mpa?action=stop":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the ssh service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","SSH"],"summary":"Restart, start or stop the ssh service","x-vmw-nsx-module":"NodeSSHService","consumes":["application/json"],"operationId":"CreateSSHServiceActionNotifyMpaStop"}},"/node/services/cm-inventory?action=start":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the manager service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Cm Inventory Service"],"summary":"Restart, start or stop the manager service","x-vmw-nsx-module":"NodeCminventoryService","consumes":["application/json"],"operationId":"CreateCminventoryServiceActionStart"}},"/logical-routers/{logical-router-id}/routing/ip-prefix-lists/{id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IPPrefixList"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update a specific IPPrefixList on the specified logical router.\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"required":true,"type":"string","name":"id","in":"path"},{"schema":{"$ref":"#/definitions/IPPrefixList"},"required":true,"name":"IPPrefixList","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Routing Configuration"],"summary":"Update a specific IPPrefixList on a Logical Router","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"UpdateIPPrefixList"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IPPrefixList"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read a specific IPPrefixList on the specified logical router.\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"required":true,"type":"string","name":"id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Routing Configuration"],"summary":"Get a specific IPPrefixList on a Logical Router","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"ReadIPPrefixList"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Deletes a specific IPPrefixList on the specified logical router.\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"required":true,"type":"string","name":"id","in":"path"}],"tags":["Management Plane API","Networking","Logical Routing And Services","Routing Configuration"],"summary":"Delete a specific IPPrefixList on a Logical Router","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"DeleteIPPrefixList"}},"/mac-sets/{mac-set-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MACSet"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Updates the specified MACSet. Modifiable parameters include the\ndescription, display_name and mac_addresses.\n","parameters":[{"description":"MACSet Id","required":true,"type":"string","name":"mac-set-id","in":"path"},{"schema":{"$ref":"#/definitions/MACSet"},"required":true,"name":"MACSet","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Grouping Objects","MAC Sets"],"summary":"Update MACSet","x-vmw-nsx-module":"MACSet","consumes":["application/json"],"operationId":"UpdateMACSet"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"409":{"description":"Conflict"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Deletes the specified MACSet. By default, if the MACSet is added to an\nNSGroup, it won't be deleted. In such situations, pass \"force=true\" as\nquery param to force delete the MACSet.\n","parameters":[{"description":"MACSet Id","required":true,"type":"string","name":"mac-set-id","in":"path"},{"default":false,"description":"Force delete the resource even if it is being used somewhere\n","type":"boolean","name":"force","in":"query"}],"tags":["Management Plane API","Grouping Objects","MAC Sets"],"summary":"Delete MACSet","x-vmw-nsx-module":"MACSet","consumes":["application/json"],"operationId":"DeleteMACSet"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MACSet"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about the specified MACSet\n","parameters":[{"description":"MACSet Id","required":true,"type":"string","name":"mac-set-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Grouping Objects","MAC Sets"],"summary":"Read MACSet","x-vmw-nsx-module":"MACSet","consumes":["application/json"],"operationId":"ReadMACSet"}},"/node/management-plane":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ManagementPlaneProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update the management plane configuration for this node.","parameters":[{"schema":{"$ref":"#/definitions/ManagementPlaneProperties"},"required":true,"name":"ManagementPlaneProperties","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Management Plane"],"summary":"Update management plane configuration for this node","x-vmw-nsx-module":"ManagementPlaneModule","consumes":["application/json"],"operationId":"UpdateManagementPlaneConfiguration"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ManagementPlaneProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Retrieve the management plane configuration for this node to identify the Manager node with which the controller service is communicating.","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Management Plane"],"summary":"Get management plane configuration for this node","x-vmw-nsx-module":"ManagementPlaneModule","consumes":["application/json"],"operationId":"ReadManagementPlaneConfiguration"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete the management plane configuration for this node.","tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Management Plane"],"summary":"Delete management plane configuration for this node","x-vmw-nsx-module":"ManagementPlaneModule","consumes":["application/json"],"operationId":"DeleteManagementPlaneConfiguration"}},"/idfw/idfw-compute-collections":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IdfwEnabledComputeCollectionListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"List all Identity firewall compute collections.\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Security","Identity Firewall","Configuration"],"summary":"List all Identity firewall compute collections","x-vmw-nsx-module":"IdentityFirewall","consumes":["application/json"],"operationId":"ListEnabledComputeCollections"}},"/logical-ports/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LogicalPortStatusSummary"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns operational status of all logical ports.\nThe query parameter \"source=realtime\" is not supported.\nPagination is not supported for this API.\nThe query parameters \"cursor\", \"sort_ascending\", \"sort_by\", \"page_size\" and \"included_fields\"\nwill be ignored.\n","parameters":[{"description":"Logical Port attachment Id","required":false,"type":"string","name":"attachment_id","in":"query"},{"enum":["VIF","LOGICALROUTER","BRIDGEENDPOINT","DHCP_SERVICE","METADATA_PROXY","L2VPN_SESSION","NONE"],"description":"Type of attachment for logical port; for query only.","required":false,"in":"query","type":"string","name":"attachment_type"},{"description":"Bridge Cluster identifier","required":false,"type":"string","name":"bridge_cluster_id","in":"query"},{"description":"Only container VIF logical ports will be returned if true","default":false,"required":false,"in":"query","type":"boolean","name":"container_ports_only"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Flag to enable showing of transit logical port.","default":false,"required":false,"in":"query","type":"boolean","name":"diagnostic"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Logical Switch identifier","required":false,"type":"string","name":"logical_switch_id","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"description":"ID of the VIF of type PARENT","required":false,"type":"string","name":"parent_vif_id","in":"query"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"},{"description":"Network Profile identifier","required":false,"type":"string","name":"switching_profile_id","in":"query"},{"description":"Transport node identifier","required":false,"type":"string","name":"transport_node_id","in":"query"},{"description":"Transport zone identifier","required":false,"type":"string","name":"transport_zone_id","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Switching","Logical Switch Ports"],"summary":"Get Operational Status Summary of All Logical Ports in the System","x-vmw-nsx-module":"AggSvcLogicalPort","consumes":["application/json"],"operationId":"GetLogicalPortStatusSummary"}},"/md-proxies/{proxy-id}/{logical-switch-id}/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MetadataProxyStatus"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the status of the given metadata proxy and attached logical switch.\n","parameters":[{"required":true,"type":"string","name":"proxy-id","in":"path"},{"required":true,"type":"string","name":"logical-switch-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Metadata Proxy"],"summary":"Get Metadata Proxy status with given proxy id and attached logical switch.","x-vmw-nsx-module":"AggSvcMetadataProxy","consumes":["application/json"],"operationId":"GetMetadataProxyStatus"}},"/firewall/sections/{section-id}/state":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FirewallSectionState"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Return realized state information of a firewall section.\n","parameters":[{"required":true,"type":"string","name":"section-id","in":"path"},{"name":"barrier_id","format":"int64","required":false,"minimum":0,"in":"query","type":"integer"},{"description":"Realization request ID","required":false,"type":"string","name":"request_id","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Firewall"],"summary":"Get the Realized State of a Firewall Section","x-vmw-nsx-module":"Firewall","consumes":["application/json"],"operationId":"GetSectionState"}},"/dns/forwarders/{forwarder-id}/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DnsForwarderStatus"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the current status of the given DNS forwarder.\n","parameters":[{"required":true,"type":"string","name":"forwarder-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","DNS"],"summary":"Get current status of the given DNS forwarder","x-vmw-nsx-module":"AggSvcDnsForwarder","consumes":["application/json"],"operationId":"GetDnsForwarderStatus"}},"/node/version":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeVersion"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read node version","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Settings"],"summary":"Read node version","x-vmw-nsx-module":"NodeVersion","consumes":["application/json"],"operationId":"ReadNodeVersion"}},"/ns-services":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/NSService"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Creates a new NSService which allows users to specify characteristics to use\nfor matching network traffic.\n","parameters":[{"schema":{"$ref":"#/definitions/NSService"},"required":true,"name":"NSService","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Grouping Objects","NS Services"],"summary":"Create NSService","x-vmw-nsx-module":"NSService","consumes":["application/json"],"operationId":"CreateNSService"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NSServiceListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns paginated list of NSServices\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Fetch all default NSServices","type":"boolean","name":"default_service","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Grouping Objects","NS Services"],"summary":"List all NSServices","x-vmw-nsx-module":"NSService","consumes":["application/json"],"operationId":"ListNSServices"}},"/node/services/ssh/notify_mpa?action=start":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the ssh service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","SSH"],"summary":"Restart, start or stop the ssh service","x-vmw-nsx-module":"NodeSSHService","consumes":["application/json"],"operationId":"CreateSSHServiceActionNotifyMpaStart"}},"/directory/domains/{domain-id}/ldap-servers/{server-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DirectoryLdapServer"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update a LDAP server for directory domain","parameters":[{"description":"Directory domain identifier","required":true,"type":"string","name":"domain-id","in":"path"},{"description":"LDAP server identifier","required":true,"type":"string","name":"server-id","in":"path"},{"schema":{"$ref":"#/definitions/DirectoryLdapServer"},"required":true,"name":"DirectoryLdapServer","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Directory Service","LDAP Servers"],"summary":"Update a LDAP server for directory domain","x-vmw-nsx-module":"DirectoryService","consumes":["application/json"],"operationId":"UpdateDirectoryLdapServer"},"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"description":"Internal Server Error"}},"description":"The API tests a LDAP server connection for an already configured domain. If the connection is successful, the response will be HTTP status 200. Otherwise the response will be HTTP status 500 and corresponding error message will be returned.","parameters":[{"description":"Directory domain identifier","required":true,"type":"string","name":"domain-id","in":"path"},{"description":"LDAP server identifier","required":true,"type":"string","name":"server-id","in":"path"},{"enum":["CONNECTIVITY"],"description":"LDAP server test requested","required":true,"in":"query","type":"string","name":"action"}],"produces":["application/json"],"tags":["System Administration","Configuration","Directory Service","LDAP Servers"],"summary":"Test a LDAP server connection for directory domain","x-vmw-nsx-module":"DirectoryService","consumes":["application/json"],"operationId":"TestDirectoryLdapServer"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DirectoryLdapServer"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get a specific LDAP server for a given directory domain","parameters":[{"description":"Directory domain identifier","required":true,"type":"string","name":"domain-id","in":"path"},{"description":"LDAP server identifier","required":true,"type":"string","name":"server-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","Directory Service","LDAP Servers"],"summary":"Get a specific LDAP server for a given directory domain","x-vmw-nsx-module":"DirectoryService","consumes":["application/json"],"operationId":"GetDirectoryLdapServer"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete a LDAP server for directory domain","parameters":[{"description":"Directory domain identifier","required":true,"type":"string","name":"domain-id","in":"path"},{"description":"LDAP server identifier","required":true,"type":"string","name":"server-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","Directory Service","LDAP Servers"],"summary":"Delete a LDAP server for directory domain","x-vmw-nsx-module":"DirectoryService","consumes":["application/json"],"operationId":"DeleteDirectoryLdapServer"}},"/batch":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BatchResponse"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Enables you to make multiple API requests using a single request. The batch\nAPI takes in an array of logical HTTP requests represented as JSON arrays.\nEach request has a method (GET, PUT, POST, or DELETE), a relative_url (the\nportion of the URL after https://<nsx-mgr>/api/), optional headers\narray (corresponding to HTTP headers) and an optional body (for POST and PUT\nrequests). The batch API returns an array of logical HTTP responses\nrepresented as JSON arrays. Each response has a status code, an optional\nheaders array and an optional body (which is a JSON-encoded string).\n","parameters":[{"schema":{"$ref":"#/definitions/BatchRequest"},"required":true,"name":"BatchRequest","in":"body"},{"description":"Ignored (transactional atomicity flag)","default":false,"required":false,"in":"query","type":"boolean","name":"atomic"}],"produces":["application/json"],"tags":["System Administration","Configuration","NSX Managers","API Services","API Request Batching"],"summary":"Register a Collection of API Calls at a Single End Point","x-vmw-nsx-module":"Batch","consumes":["application/json"],"operationId":"RegisterBatchRequest"}},"/cluster/nodes/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ClustersAggregateInfo"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read aggregated runtime status of all cluster nodes.\nDeprecated. Use GET /cluster/status instead.\n","produces":["application/json"],"tags":["System Administration","Configuration","NSX Managers","Clusters","Cluster Status"],"summary":"Read cluster runtime status","x-vmw-nsx-module":"ClusterManagement","consumes":["application/json"],"operationId":"ReadClusterNodesAggregateStatus"}},"/migration/mp-to-policy/feedback":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FeedBackListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"To get MP2Policy promotion feedback.\nThis gives all the validation errors or failures during PRECHECK / APPLY phase.\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"enum":["CURRENT","ARCHIVED"],"description":"Location flag","default":"CURRENT","required":false,"in":"query","type":"string","name":"location"},{"description":"Specify the mp resource display name to filter corresponding feedbacks.","required":false,"type":"string","name":"mp_display_name","in":"query"},{"description":"Specify the mp resource id to filter corresponding feedbacks.","required":false,"type":"string","name":"mp_id","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"description":"Specify the mp resource type to filter corresponding feedbacks.","required":false,"type":"string","name":"resource_type","in":"query"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Migration","Plan"],"summary":"To get MP2Policy promotion feedback.","x-vmw-nsx-module":"MPPolicyMigration","consumes":["application/json"],"operationId":"Mp2PolicyMigrationFeedback"}},"/node/services/nsx-platform-client":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read NSX Platform Client service properties","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","NSX Platform Client"],"summary":"Read NSX Platform Client service properties","x-vmw-nsx-module":"NodePlatformClientService","consumes":["application/json"],"operationId":"ReadPlatformClientService"}},"/cluster-profiles":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/ClusterProfile"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Create a cluster profile. The resource_type is required.\n","parameters":[{"schema":{"$ref":"#/definitions/ClusterProfile"},"required":true,"name":"ClusterProfile","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Profiles","Cluster Profiles"],"summary":"Create a Cluster Profile","x-vmw-nsx-module":"ClusterProfile","consumes":["application/json"],"operationId":"CreateClusterProfile"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ClusterProfileListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns paginated list of cluster profiles\nCluster profiles define policies for edge cluster and bridge cluster.\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Whether the list result contains system resources","default":true,"required":false,"in":"query","type":"boolean","name":"include_system_owned"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"enum":["EdgeHighAvailabilityProfile","BridgeHighAvailabilityClusterProfile"],"description":"Supported cluster profiles.","required":false,"in":"query","type":"string","name":"resource_type"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Profiles","Cluster Profiles"],"summary":"List Cluster Profiles","x-vmw-nsx-module":"ClusterProfile","consumes":["application/json"],"operationId":"ListClusterProfiles"}},"/logical-router-ports/{logical-router-port-id}/statistics":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LogicalRouterPortStatistics"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the statistics for the Logical Router Port. If query parameter\n\"transport_node_id=<transport-node-id>\" is given, only the statistics\nfrom the given node for the logical router port will be returned.\nOtherwise the statistics from each node for the same logical router port\nwill be returned. The transport_node_id is mandatory if the router port\nis not uplink type.\nThe query parameter \"source=cached\" will be ignored and it will always return\nrealtime statistics of the logical router port.\n","parameters":[{"required":true,"type":"string","name":"logical-router-port-id","in":"path"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"},{"description":"TransportNode Id","required":false,"type":"string","name":"transport_node_id","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Logical Router Ports"],"summary":"Get the statistics of a specified logical router port on all or a specified node","x-vmw-nsx-module":"AggSvcLogicalRouterPort","consumes":["application/json"],"operationId":"GetLogicalRouterPortStatistics"}},"/node/network/interfaces/{interface-id}/stats":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeInterfaceStatisticsProperties"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"On the specified interface, returns the number of received (rx), transmitted\n(tx), and dropped packets; the number of bytes and errors received and\ntransmitted on the interface; and the number of detected collisions.\n","parameters":[{"description":"ID of interface to read","required":true,"type":"string","name":"interface-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Network Interfaces"],"summary":"Read the Node's Network Interface Statistics","x-vmw-nsx-module":"NetworkInterfaceModule","consumes":["application/json"],"operationId":"ReadNetworkInterfaceStatistics"}},"/pools/ip-subnets/{subnet-id}":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AllocationIpAddress"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"409":{"description":"Conflict"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Allocates or releases an IP address from the specified IP subnet. To allocate\nan address, include ?action=ALLOCATE in the request and a \"{}\"\nin the request body. When the request is successful, the response is\n\"allocation_id\": \"<ip-address>\", where <ip-address> is an IP address from\nthe specified pool. To release an IP address (return it back to the pool),\ninclude ?action=RELEASE in the request and \"allocation_id\":<ip-address> in\nthe request body, where <ip-address> is the address to be released. When the\nrequest is successful, the response is NULL.\n","parameters":[{"description":"IP subnet id","required":true,"type":"string","name":"subnet-id","in":"path"},{"schema":{"$ref":"#/definitions/AllocationIpAddress"},"required":true,"name":"AllocationIpAddress","in":"body"},{"enum":["ALLOCATE","RELEASE"],"description":"Specifies allocate or release action","required":true,"in":"query","type":"string","name":"action"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Pool Management","IP Blocks"],"summary":"Allocate or Release an IP Address from a Ip Subnet","x-vmw-nsx-module":"Ipam","consumes":["application/json"],"operationId":"AllocateOrReleaseFromIpBlockSubnet"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Deletes a subnet with specified id within a given IP address block.\nDeletion is allowed only when there are no allocated IP addresses\nfrom that subnet.\n","parameters":[{"description":"Subnet id","required":true,"type":"string","name":"subnet-id","in":"path"}],"tags":["System Administration","Configuration","Fabric","Pool Management","IP Blocks"],"summary":"Delete subnet within an IP block","x-vmw-nsx-module":"Ipam","consumes":["application/json"],"operationId":"DeleteIpBlockSubnet"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IpBlockSubnet"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about the subnet with specified id within a given\nIP address block. Information includes display_name, description, cidr and\nallocation_ranges.\n","parameters":[{"description":"Subnet id","required":true,"type":"string","name":"subnet-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Pool Management","IP Blocks"],"summary":"Get the subnet within an IP block","x-vmw-nsx-module":"Ipam","consumes":["application/json"],"operationId":"ReadIpBlockSubnet"}},"/migration/migration-unit-groups/{group-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MigrationUnitGroup"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update the specified migration unit group. Removal of migration units from the group\nusing this is not allowed. An error will be returned in that case.\n","parameters":[{"required":true,"type":"string","name":"group-id","in":"path"},{"schema":{"$ref":"#/definitions/MigrationUnitGroup"},"required":true,"name":"MigrationUnitGroup","in":"body"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Migration","Group"],"summary":"Update the migration unit group","x-vmw-nsx-module":"Migration","consumes":["application/json"],"operationId":"UpdateMigrationUnitGroup"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MigrationUnitGroup"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about a specific migration unit group in the\nmigration plan. If request parameter summary is set to true, then\nonly count of migration units will be returned, migration units list\nwill be empty.\n","parameters":[{"required":true,"type":"string","name":"group-id","in":"path"},{"description":"Flag indicating whether to return the summary","default":false,"required":false,"in":"query","type":"boolean","name":"summary"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Migration","Group"],"summary":"Return migration unit group information","x-vmw-nsx-module":"Migration","consumes":["application/json"],"operationId":"GetMigrationUnitGroup"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"description":"Bad Request"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete the specified group.\nNOTE - A group can be deleted only if it is empty.\nIf user tries to delete a group containing one\nor more migration units, the operation will fail and an error\nwill be returned.\n","parameters":[{"required":true,"type":"string","name":"group-id","in":"path"}],"tags":["System Administration","Lifecycle Management","Migration","Group"],"summary":"Delete the migration unit group","x-vmw-nsx-module":"Migration","consumes":["application/json"],"operationId":"DeleteMigrationUnitGroup"}},"/dhcp/servers/{server-id}/ip-pools/{pool-id}/state":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ConfigurationState"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Return realized state information of a dhcp ip pool.\nAfter a dhcp ip pool is created or updated, you can invoke this API to get\nthe realization information of the ip pool.\n","parameters":[{"required":true,"type":"string","name":"server-id","in":"path"},{"required":true,"type":"string","name":"pool-id","in":"path"},{"name":"barrier_id","format":"int64","required":false,"minimum":0,"in":"query","type":"integer"},{"description":"Realization request ID","required":false,"type":"string","name":"request_id","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","DHCP"],"summary":"Get the realized state of a dhcp ip pool","x-vmw-nsx-module":"Dhcp","consumes":["application/json"],"operationId":"GetDhcpIpPoolState"}},"/migration/summary":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MigrationSummary"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get migration summary","produces":["application/json"],"tags":["System Administration","Lifecycle Management","Migration","Status"],"summary":"Get migration summary","x-vmw-nsx-module":"Migration","consumes":["application/json"],"operationId":"GetMigrationSummary"}},"/md-proxies/{proxy-id}/statistics":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MetadataProxyStatistics"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the statistics of the given metatada proxy. If no logical switch\nis provided, all staticstics of all the logical switches the proxy was\nattached will be returned.\n","parameters":[{"required":true,"type":"string","name":"proxy-id","in":"path"},{"description":"The uuid of logical switch","required":false,"type":"string","name":"logical_switch_id","in":"query"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"}],"produces":["application/json"],"tags":["Management Plane API","Services","Metadata Proxy"],"summary":"Get Metadata Proxy statistics with given proxy id","x-vmw-nsx-module":"AggSvcMetadataProxy","consumes":["application/json"],"operationId":"GetMetadataProxyStatistics"}},"/node/file-store/{file-name}?action=copy_from_remote_file":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/FileProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"409":{"description":"Conflict"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"504":{"description":"Gateway Timeout"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Copy a remote file to the file store. If you use scp or sftp,\nyou must provide the remote server's SSH fingerprint. See the\nNSX-T Administration Guide for information and instructions\nabout finding the SSH fingerprint.\n","parameters":[{"description":"Destination filename","required":true,"type":"string","name":"file-name","in":"path"},{"schema":{"$ref":"#/definitions/CopyFromRemoteFileProperties"},"required":true,"name":"CopyFromRemoteFileProperties","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","File Store"],"summary":"Copy a remote file to the file store","x-vmw-nsx-module":"FileStoreModule","consumes":["application/json"],"operationId":"CopyFromRemoteFileCopyFromRemoteFile"}},"/node/services/node-mgmt":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read appliance management service properties","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","Node Management"],"summary":"Read appliance management service properties","x-vmw-nsx-module":"NodeApplianceManagementService","consumes":["application/json"],"operationId":"ReadApplianceManagementService"}},"/serviceinsertion/sections/{section-id}?action=update_with_rules":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ServiceInsertionSectionRuleList"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Modifies existing serviceinsertion section along with its association with rules.\nWhen invoked on a large number of rules, this API is supported only at low\nrates of invocation (not more than 2 times per minute). The typical latency\nof this API with about 1024 rules is about 15 seconds in a cluster setup.\nThis API should not be invoked with large payloads at automation speeds.\n\nInstead, to update rule content, use:\nPUT /api/v1/serviceinsertion/sections/<section-id>/rules/<rule-id>\nNote- POST service insertion section with rules API is deprecated.\nPlease use policy redirection-policy API.\n","parameters":[{"required":true,"type":"string","name":"section-id","in":"path"},{"schema":{"$ref":"#/definitions/ServiceInsertionSectionRuleList"},"required":true,"name":"ServiceInsertionSectionRuleList","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Update an Existing Section, Including Its Rules","x-vmw-nsx-module":"ServiceInsertionRules","consumes":["application/json"],"operationId":"UpdateServiceInsertionSectionWithRules"}},"/pools/ip-pools":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/IpPool"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Creates a new IPv4 or IPv6 address pool. Required parameters are\nallocation_ranges and cidr. Optional parameters are display_name,\ndescription, dns_nameservers, dns_suffix, and gateway_ip.\n","parameters":[{"schema":{"$ref":"#/definitions/IpPool"},"required":true,"name":"IpPool","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Pool Management","IP Pools"],"summary":"Create an IP Pool","x-vmw-nsx-module":"Ipam","consumes":["application/json"],"operationId":"CreateIpPool"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IpPoolListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about the configured IP address pools. Information\nincludes the display name and description of the pool and the details of\neach of the subnets in the pool, including the DNS servers, allocation\nranges, gateway, and CIDR subnet address.\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Pool Management","IP Pools"],"summary":"List IP Pools","x-vmw-nsx-module":"Ipam","consumes":["application/json"],"operationId":"ListIpPools"}},"/node/processes":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeProcessPropertiesListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the number of processes and information about each\nprocess. Process information includes 1) mem_resident, which is roughly\nequivalent to the amount of RAM, in bytes, currently used by the process,\n2) parent process ID (ppid), 3) process name, 4) process up time in milliseconds,\n5) mem_used, wich is the amount of virtual memory used by the process, in\nbytes, 6) process start time, in milliseconds since epoch, 7) process ID\n(pid), 8) CPU time, both user and the system, consumed by the process in\nmilliseconds.\n","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Settings"],"summary":"List node processes","x-vmw-nsx-module":"NodeProcesses","consumes":["application/json"],"operationId":"ListNodeProcesses"}},"/loadbalancer/services/{service-id}/virtual-servers/statistics":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LbVirtualServerStatisticsListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the statistics list of virtual servers in given load balancer service.\nCurrently, only realtime mode is supported.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Get the statistics list of virtual servers","x-vmw-nsx-module":"AggSvcLb","consumes":["application/json"],"operationId":"ListLoadBalancerVirtualServersStatistics"}},"/ns-groups/{nsgroup-id}/service-associations":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ServiceAssociationListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about services that are associated with the given NSGroup.\nThe service name is passed by service_type parameter\n","parameters":[{"required":true,"type":"string","name":"nsgroup-id","in":"path"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Fetch complete list of associated resources considering\nnesting\n","default":false,"required":false,"in":"query","type":"boolean","name":"fetch_parentgroup_associations"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"required":true,"type":"string","name":"service_type","enum":["firewall","ipfix"],"in":"query"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Grouping Objects","NS Groups"],"summary":"Get services to which the given nsgroup belongs to\n","x-vmw-nsx-module":"GroupingObjectsProviders","consumes":["application/json"],"operationId":"GetServiceAssociations"}},"/node/services/policy/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read service status","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Policy Service"],"summary":"Read service status","x-vmw-nsx-module":"NodePolicyService","consumes":["application/json"],"operationId":"ReadPolicyServiceStatus"}},"/node/services/messaging-manager":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read NSX Messaging Manager service properties","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Messaging Manager Service"],"summary":"Read NSX Messaging Manager service properties","x-vmw-nsx-module":"NodeNSXMessagingManagerService","consumes":["application/json"],"operationId":"ReadNSXMessagingManagerService"}},"/cluster/restore?action=start":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ClusterRestoreStatus"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"500":{"$ref":"#/responses/InternalServerError"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ClusterRestoreStatus"}}},"description":"Start the restore of an NSX cluster, from some previously\nbacked-up configuration. This operation is only valid\nwhen a GET cluster/restore/status returns a status with value NOT_STARTED.\nOtherwise, a 409 response is returned.\n","parameters":[{"schema":{"$ref":"#/definitions/InitiateClusterRestoreRequest"},"required":true,"name":"InitiateClusterRestoreRequest","in":"body"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Backup Restore Management","Restore"],"summary":"Initiate a restore operation","x-vmw-nsx-module":"ClusterRestore","consumes":["application/json"],"operationId":"InitiateClusterRestore"}},"/node/users/{userid}/ssh-keys?action=add_ssh_key":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"description":"Internal Server Error"}},"description":"Add SSH public key to authorized_keys file for node user","parameters":[{"description":"User id of the user","required":true,"type":"string","name":"userid","in":"path"},{"schema":{"$ref":"#/definitions/SshKeyProperties"},"required":true,"name":"SshKeyProperties","in":"body"}],"tags":["System Administration","Configuration","Fabric","Nodes","User Management","Users"],"summary":"Add SSH public key to authorized_keys file for node user","x-vmw-nsx-module":"NodeUsers","consumes":["application/json"],"operationId":"AddNodeUserSshKeyAddSshKey"}},"/node/network/routes/{route-id}":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeRouteProperties"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns detailed information about a specified route in the node\nrouting table.\n","parameters":[{"description":"ID of route to read","required":true,"type":"string","name":"route-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Network Interfaces","Routing"],"summary":"Read node network route","x-vmw-nsx-module":"NodeNetworkRoutesModule","consumes":["application/json"],"operationId":"ReadNodeNetworkRoute"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete a route from the node routing table. You can modify an\nexisting route by deleting it and then posting the modified version of the\nroute. To verify, remove the route ID from the URI, issue a GET request, and\nnote the absense of the deleted route.\n","parameters":[{"description":"ID of route to delete","required":true,"type":"string","name":"route-id","in":"path"}],"tags":["System Administration","Configuration","Fabric","Nodes","Network Interfaces","Routing"],"summary":"Delete node network route","x-vmw-nsx-module":"NodeNetworkRoutesModule","consumes":["application/json"],"operationId":"DeleteNodeNetworkRoute"}},"/serviceinsertion/services/{service-id}/service-instances/{service-instance-id}/instance-endpoints/{instance-endpoint-id}":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/InstanceEndpoint"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns detailed Endpoint information for a given InstanceEndpoint.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"required":true,"type":"string","name":"service-instance-id","in":"path"},{"required":true,"type":"string","name":"instance-endpoint-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Get a particular instance endpoint for a service instance.","x-vmw-nsx-module":"ServiceInsertion","consumes":["application/json"],"operationId":"GetInstanceEndpoint"},"delete":{"responses":{"200":{"description":"OK"},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete instance endpoint information for a given instace endpoint.\nPlease make sure to delete all the Service Insertion Rules, which\nrefer to this Endpoint as 'redirect_tos' target.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"required":true,"type":"string","name":"service-instance-id","in":"path"},{"required":true,"type":"string","name":"instance-endpoint-id","in":"path"}],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Delete a particular InstanceEndpoint.","x-vmw-nsx-module":"ServiceInsertion","consumes":["application/json"],"operationId":"DeleteInstanceEndpoint"}},"/node/upgrade/uc":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"description":"Internal Server Error"}},"description":"Triggers repository driven uc upgrade on the node. This API expects that repository is\nsynced across nodes before starting upgrade.\n","parameters":[{"schema":{"$ref":"#/definitions/TriggerUcUpgradeParameters"},"required":true,"name":"TriggerUcUpgradeParameters","in":"body"}],"tags":["System Administration","Lifecycle Management","Upgrade","Upgrade Coordinator"],"summary":"Triggers Repository driven Uc Upgrade","x-vmw-nsx-module":"UpgradeCoordinatorModule","consumes":["application/json"],"operationId":"TriggerRepositoryDrivenUcUpgrade"}},"/systemhealth/appliances/process/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ApplianceProcessListResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Show the details of process status in all appliances.\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["System Administration","Monitoring","System Health","Appliance","Process"],"summary":"Show the details of process status in all appliances.","x-vmw-nsx-module":"ShaApplianceMonitor","consumes":["application/json"],"operationId":"ShowALLApplianceProcessData"}},"/loadbalancer/services/{service-id}/statistics":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LbServiceStatistics"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the statistics of the given load balancer service.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Get the statistics of load balancer service","x-vmw-nsx-module":"AggSvcLb","consumes":["application/json"],"operationId":"GetLoadBalancerServiceStatistics"}},"/migration/plan/{component_type}/settings":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MigrationPlanSettings"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"description":"Bad Request"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update the migration plan settings for the component.\n","parameters":[{"required":true,"type":"string","name":"component_type","in":"path"},{"schema":{"$ref":"#/definitions/MigrationPlanSettings"},"required":true,"name":"MigrationPlanSettings","in":"body"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Migration","Plan"],"summary":"Update migration plan settings for the component","x-vmw-nsx-module":"Migration","consumes":["application/json"],"operationId":"UpdateMigrationPlanSettings"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MigrationPlanSettings"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get the migration plan settings for the component.\n","parameters":[{"required":true,"type":"string","name":"component_type","in":"path"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Migration","Plan"],"summary":"Get migration plan settings for the component","x-vmw-nsx-module":"Migration","consumes":["application/json"],"operationId":"GetMigrationPlanSettings"}},"/events/{event-id}?action=set_default":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MonitoringEvent"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Reset all user configurable values for event identified by event-id to factory defaults.","parameters":[{"required":true,"type":"string","name":"event-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Monitoring","Alarms And Events"],"summary":"Reset all user configurable values to factory defaults.","x-vmw-nsx-module":"Monitoring","consumes":["application/json"],"operationId":"ResetEventValues"}},"/lldp/transport-nodes/{node-id}/interfaces":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/InterfaceNeighborPropertyListResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"List LLDP Neighbor Properties for all interfaces of Transport Node\n","parameters":[{"description":"ID of transport node","required":true,"type":"string","name":"node-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","LLDP"],"summary":"List LLDP Neighbor Properties of Transport Node","x-vmw-nsx-module":"Lldp","consumes":["application/json"],"operationId":"ListNeighborProperties"}},"/idfw/transport-nodes/{transport-node-id}/vms/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IdfwVirtualMachineStatusListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Retrieve all the VM and status by transport node ID of idfw enabled compute\ncollection in the request.\n","parameters":[{"required":true,"type":"string","name":"transport-node-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Security","Identity Firewall","Monitoring"],"summary":"List all VM and statuses based on transport node ID of idfw enabled compute collection.","x-vmw-nsx-module":"IdentityFirewall","consumes":["application/json"],"operationId":"ListVirtualMachineStatusesByTransportNodeId"}},"/logical-ports/{lport-id}/forwarding-path":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PortConnectionEntities"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"description":"Bad Request"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get networking entities between two logical ports with VIF attachment","parameters":[{"description":"ID of source port","required":true,"type":"string","name":"lport-id","in":"path"},{"description":"ID of peer port","required":true,"type":"string","name":"peer_port_id","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Troubleshooting And Monitoring","Port Connection"],"summary":"Get networking entities between two logical ports with VIF attachment","x-vmw-nsx-module":"PortConnection","consumes":["application/json"],"operationId":"GetForwardingPath"}},"/fabric/container-projects/{container-project-id}":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ContainerProject"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about a specific project","parameters":[{"required":true,"type":"string","name":"container-project-id","in":"path"}],"produces":["application/json"],"tags":["Policy","Inventory","Containers","Container Projects"],"summary":"Return a container project","x-vmw-nsx-module":"InventoryContainerObj","consumes":["application/json"],"operationId":"GetContainerProject"}},"/error-resolver":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ErrorResolverInfoList"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns a list of metadata for all the error resolvers registered.\n","produces":["application/json"],"tags":["System Administration","Monitoring","Error Resolver"],"summary":"Fetches a list of metadata for all the registered error resolvers","x-vmw-nsx-module":"ErrorResolver","consumes":["application/json"],"operationId":"ListErrorResolverInfo"}},"/node/file-store":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FilePropertiesListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"List node files","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","File Store"],"summary":"List node files","x-vmw-nsx-module":"FileStoreModule","consumes":["application/json"],"operationId":"ListFiles"}},"/node/upgrade/status-summary":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UpgradeStatusSummary"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"description":"Internal Server Error"}},"description":"Get status summary of node upgrade, if upgrade bundle is present.\n","produces":["application/json"],"tags":["System Administration","Lifecycle Management","Upgrade","Nodes"],"summary":"Get upgrade status summary","x-vmw-nsx-module":"UpgradeNodeActions","consumes":["application/json"],"operationId":"GetNodeUpgradeStatusSummary"}},"/trust-management/csrs":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/Csr"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Creates a new certificate signing request (CSR). A CSR is encrypted text that\ncontains information about your organization (organization name, country,\nand so on) and your Web server's public key, which is a public certificate\nthe is generated on the server that can be used to forward this request to a\ncertificate authority (CA). A private key is also usually created at the\nsame time as the CSR.\n","parameters":[{"schema":{"$ref":"#/definitions/Csr"},"required":true,"name":"Csr","in":"body"}],"produces":["application/json"],"tags":["System Administration","Settings","Certificates","CSR"],"summary":"Generate a New Certificate Signing Request","x-vmw-nsx-module":"CertificateManager","consumes":["application/json"],"operationId":"GenerateCsr"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/CsrList"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about all of the CSRs that have been created.","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["System Administration","Settings","Certificates","CSR"],"summary":"Return All the Generated CSRs","x-vmw-nsx-module":"CertificateManager","consumes":["application/json"],"operationId":"GetCsrs"}},"/migration/plan?action=finish":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"409":{"description":"Conflict"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"This API marks the completion of one execution of migration workflow. This API resets internal \nexecution state and hence needs to be invoked before starting subsequent workflow run.\n","tags":["System Administration","Lifecycle Management","Migration","Plan"],"summary":"Mark completion of a migration cycle","x-vmw-nsx-module":"Migration","consumes":["application/json"],"operationId":"FinishMigration"}},"/sites?version=3.0.2":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FederationConfiguration"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"description":"Service Unavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get the site configuration, some attributes won't be shown based on version","produces":["application/json"],"tags":["System Administration","Configuration","Site Management"],"summary":"Get the site configuration, some attributes won't be shown based on version","x-vmw-nsx-module":"SiteManagerModule","consumes":["application/json"],"operationId":"GetSiteConfigurationVersioned302"}},"/ns-groups/{ns-group-id}/consolidated-effective-ip-address-members":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ConsolidatedEffectiveIPAddressMemberListResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns consolidated effective ip address members of the specified NSGroup.\nApplicable in case of federated environment. The response contains site-wise list of\nconsolidated effective IP address members. In the response, for the local-site, the\nlist will contain static and dynamicaly translated IPs. For the remote sites,\nthe list will contain only the dynamically translated IPs. The static IPs will not be\nseen in the response of this API. Hence, user can refer to the local-site Ip response\nin the API results or the group definition to see the static IP membership of the Group.\nThis API is applicable only for NSGroups containing either\nVirtualMachine, VIF, LogicalSwitch, LogicalPort or IPSet member type.\nFor NSGroups containing other member types,it returns an empty list.\nUse the cursor value in the response to fetch the next page.\nIf there is no cursor value for a response, it implies the last page in the results\nfor the query.\n","parameters":[{"description":"NSGroup Id","required":true,"type":"string","name":"ns-group-id","in":"path"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"IP address, range, or subnet","format":"address-or-block-or-range","required":false,"in":"query","type":"string","name":"ip_filter"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"description":"UUID of the site from which the effective IP addresses are to be fetched\n","required":false,"type":"string","name":"site_id","in":"query"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Grouping Objects","NS Groups"],"summary":"Get consolidated Effective IPAddress translated from the NSGroup","x-vmw-nsx-module":"GroupingObjectsProviders","consumes":["application/json"],"operationId":"GetConsolidatedEffectiveIPAddressMembers"}},"/logical-routers/{logical-router-id}/routing/route-maps/{id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RouteMap"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update a specific RouteMap on the specified logical router.\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"required":true,"type":"string","name":"id","in":"path"},{"schema":{"$ref":"#/definitions/RouteMap"},"required":true,"name":"RouteMap","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Routing Configuration"],"summary":"Update a specific RouteMap on a Logical Router","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"UpdateRouteMap"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RouteMap"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read a specific RouteMap on the specified logical router.\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"required":true,"type":"string","name":"id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Routing Configuration"],"summary":"Get a specific RouteMap on a Logical Router","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"ReadRouteMap"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Deletes a specific RouteMap on the specified logical router.\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"required":true,"type":"string","name":"id","in":"path"}],"tags":["Management Plane API","Networking","Logical Routing And Services","Routing Configuration"],"summary":"Delete a specific RouteMap on a Logical Router","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"DeleteRouteMap"}},"/migration/plan?action=continue":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"409":{"description":"Conflict"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Continue the migration. Resumes the migration from the point where\nit was paused.\n","parameters":[{"description":"Skip to migration of next component.","default":false,"required":false,"in":"query","type":"boolean","name":"skip"}],"tags":["System Administration","Lifecycle Management","Migration","Plan"],"summary":"Continue migration","x-vmw-nsx-module":"Migration","consumes":["application/json"],"operationId":"ContinueMigration"}},"/node/hardening-policy/mandatory-access-control/report":{"get":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get the report for Mandatory Access Control","produces":["application/octet-stream"],"tags":["System Administration","Configuration","Fabric","Nodes","Hardening","Mandatory Access Control"],"summary":"Get the report for Mandatory Access Control","x-vmw-nsx-module":"NodeMandatoryAccessControlModule","consumes":["application/json"],"operationId":"GetNodeMandatoryAccessControlReport"}},"/loadbalancer/services/{service-id}/pools/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LbPoolStatusListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the status list of load balancer pools in given load balancer service.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Get the status list of load balancer pools","x-vmw-nsx-module":"AggSvcLb","consumes":["application/json"],"operationId":"ListLoadBalancerPoolStatuses"}},"/logical-ports/{lport-id}/statistics":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LogicalPortStatistics"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns statistics of a specified logical port. If the logical port is attached to\na logical router port, query parameter \"source=realtime\" is not supported.\n","parameters":[{"required":true,"type":"string","name":"lport-id","in":"path"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Switching","Logical Switch Ports"],"summary":"Get Statistics for Logical Port of a Given Port ID (lport-id)","x-vmw-nsx-module":"AggSvcLogicalPort","consumes":["application/json"],"operationId":"GetLogicalPortStatistics"}},"/aaa/vidm/search":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/VidmInfoListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"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. This API will return as many results that vIDM returns to NSX during the search query. vIDM may not send all results at once so to zero in on the user/group of interest more characters need to be entered.","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"description":"Search string to search for.\n","required":true,"type":"string","name":"search_string","in":"query"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["System Administration","Settings","User Management","VIDM Configuration"],"summary":"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. This API will return as many results that vIDM returns to NSX during the search query. vIDM may not send all results at once so to zero in on the user/group of interest more characters need to be entered.","x-vmw-nsx-module":"AAA","consumes":["application/json"],"operationId":"GetVidmSearchResult"}},"/node/services/install-upgrade/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read NSX install-upgrade service status","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Install Upgrade Service"],"summary":"Read NSX install-upgrade service status","x-vmw-nsx-module":"NodeInstallUpgradeService","consumes":["application/json"],"operationId":"ReadRepositoryServiceStatus"}},"/firewall/sections/{section-id}/rules/{rule-id}/stats":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FirewallStats"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get aggregated statistics for a rule for given firewall section. The\nAPI only supports access to cached (source=cached) statistical data\ncollected offline in the system. Data includes total number of packets,\nbytes, sessions counters and popularity index for a firewall rule and\noverall session count, max session count and max popularity index for\nall firewall rules on transport nodes or edge nodes. Aggregated\nstatistics like maximum popularity index, maximum session count and\ntotal session count are computed with lower frequency compared to\nindividual generic rule statistics, hence they may have a computation\ndelay up to 15 minutes to reflect in response to this API.\n","parameters":[{"required":true,"type":"string","name":"section-id","in":"path"},{"required":true,"type":"string","name":"rule-id","in":"path"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Firewall"],"summary":"Get Firewall rule level statistics","x-vmw-nsx-module":"FirewallStatsRule","consumes":["application/json"],"operationId":"GetFirewallStats"}},"/firewall/rules/{rule-id}/state":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RuleState"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Return realized state information of a firewall rule. Returned response is same as rule's\nsection realization state response.\n","parameters":[{"required":true,"type":"string","name":"rule-id","in":"path"},{"name":"barrier_id","format":"int64","required":false,"minimum":0,"in":"query","type":"integer"},{"description":"Realization request ID","required":false,"type":"string","name":"request_id","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Firewall"],"summary":"Get the Realized State of a Firewall Rule","x-vmw-nsx-module":"Firewall","consumes":["application/json"],"operationId":"GetRuleState"}},"/logical-switches/{logical-switch-id}/inter-site-forwarder/site-span-info":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/L2ForwarderRemoteMacs"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns remote mac addresses of the l2 forwarder on logical switch.\nIt always returns realtime response.\n","parameters":[{"required":true,"type":"string","name":"logical-switch-id","in":"path"}],"produces":["application/json"],"tags":["Federation","Inter-Sites"],"summary":"Get L2 forwarder remote mac addresses","x-vmw-nsx-module":"AggSvcL2Forwarder","consumes":["application/json"],"operationId":"GetL2ForwarderRemoteMacs"}},"/logical-routers/{logical-router-id}/nat/rules/{rule-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NatRule"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update a specific NAT rule from a given logical router.\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"required":true,"type":"string","name":"rule-id","in":"path"},{"schema":{"$ref":"#/definitions/NatRule"},"required":true,"name":"NatRule","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","NAT"],"summary":"Update a specific NAT rule from a given logical router","x-vmw-nsx-module":"Nat","consumes":["application/json"],"operationId":"UpdateNatRule"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NatRule"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get a specific NAT rule from a given logical router\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"required":true,"type":"string","name":"rule-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","NAT"],"summary":"Get a specific NAT rule from a given logical router","x-vmw-nsx-module":"Nat","consumes":["application/json"],"operationId":"GetNatRule"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete a specific NAT rule from a logical router\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"required":true,"type":"string","name":"rule-id","in":"path"}],"tags":["Management Plane API","Networking","Logical Routing And Services","NAT"],"summary":"Delete a specific NAT rule from a logical router","x-vmw-nsx-module":"Nat","consumes":["application/json"],"operationId":"DeleteNatRule"}},"/ipfix/collectorconfigs/{collector-config-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IpfixCollectorConfig"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update an existing IPFIX collector configuration","parameters":[{"required":true,"type":"string","name":"collector-config-id","in":"path"},{"schema":{"$ref":"#/definitions/IpfixCollectorConfig"},"required":true,"name":"IpfixCollectorConfig","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Troubleshooting And Monitoring","IPFIX"],"summary":"Update an existing IPFIX collector configuration","x-vmw-nsx-module":"Ipfix","consumes":["application/json"],"operationId":"UpdateIpfixCollectorConfig"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete an existing IPFIX collector configuration","parameters":[{"required":true,"type":"string","name":"collector-config-id","in":"path"}],"tags":["Management Plane API","Troubleshooting And Monitoring","IPFIX"],"summary":"Delete an existing IPFIX collector configuration","x-vmw-nsx-module":"Ipfix","consumes":["application/json"],"operationId":"DeleteIpfixCollectorConfig"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IpfixCollectorConfig"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get an existing IPFIX collector configuration","parameters":[{"required":true,"type":"string","name":"collector-config-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Troubleshooting And Monitoring","IPFIX"],"summary":"Get an existing IPFIX collector configuration","x-vmw-nsx-module":"Ipfix","consumes":["application/json"],"operationId":"GetIpfixCollectorConfig"}},"/automatic-health-check-toggle":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AutomaticHealthCheckToggle"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Change status of automatic health check toggle to enabled/disabled.","parameters":[{"schema":{"$ref":"#/definitions/AutomaticHealthCheckToggle"},"required":true,"name":"AutomaticHealthCheckToggle","in":"body"}],"produces":["application/json"],"tags":["System Administration","Monitoring","Health Checks"],"summary":"Update automatic health check toggle","x-vmw-nsx-module":"HealthCheck","consumes":["application/json"],"operationId":"UpdateAutomaticHealthCheckToggle"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AutomaticHealthCheckToggle"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get detailed info for automatic health check toggle.","produces":["application/json"],"tags":["System Administration","Monitoring","Health Checks"],"summary":"Get automatic health check toggle","x-vmw-nsx-module":"HealthCheck","consumes":["application/json"],"operationId":"GetAutomaticHealthCheckToggle"}},"/cluster/backups/overview":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BackupOverview"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get a configuration of a file server, timers for automated backup,\nlatest backup status, backups list for a site.\nFields that contain secrets (password, passphrase) are not returned.\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"enum":["GLOBAL_MANAGER","LOCAL_MANAGER","LOCAL_LOCAL_MANAGER","NSX_INTELLIGENCE"],"description":"Frame type","default":"LOCAL_LOCAL_MANAGER","required":false,"in":"query","type":"string","name":"frame_type"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"description":"Need a list of backups","default":true,"required":false,"in":"query","type":"boolean","name":"show_backups_list"},{"description":"UUID of the site","default":"localhost","required":false,"in":"query","type":"string","name":"site_id"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Backup Restore Management","Backup"],"summary":"Get all backup related information for a site","x-vmw-nsx-module":"BackupConfiguration","consumes":["application/json"],"operationId":"GetBackupOverview"}},"/cluster":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ClusterConfig"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about the NSX cluster configuration. An NSX cluster has\ntwo functions or purposes, commonly referred to as \"roles.\" These two roles\nare control and management. Each NSX installation has a single cluster.\nSeparate NSX clusters do not share data. In other words, a given data-plane\nnode is attached to only one cluster, not to multiple clusters.\n","produces":["application/json"],"tags":["System Administration","Configuration","NSX Managers","Clusters","Cluster Configuration"],"summary":"Read Cluster Configuration","x-vmw-nsx-module":"ClusterManagement","consumes":["application/json"],"operationId":"ReadClusterConfig"}},"/node/core-dumps":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FilePropertiesListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"List system core dumps","produces":["application/json"],"tags":["System Administration","Monitoring","Logs","Core Dumps"],"summary":"List system core dumps","x-vmw-nsx-module":"CoreDumpModule","consumes":["application/json"],"operationId":"ListCoreDumps"}},"/administration/support-bundles/dynamic-content-filters":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DynamicContentFilters"}},"413":{"description":"Request Entity Too Large"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"description":"Service Unavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get list of supported content filters that decide the contents of the support bundle. This depends on target form factor.","parameters":[{"description":"Restrict scope of dynamic content filters to report","enum":["NAPP"],"type":"string","name":"scope","in":"query"}],"produces":["application/json","application/octet-stream"],"tags":["System Administration","Settings","Support Bundle"],"summary":"Get list of supported content filters","x-vmw-nsx-module":"NodeSupportBundle","consumes":["application/json"],"operationId":"GetDynamicContentFilterValues"}},"/logical-switches/{lswitch-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LogicalSwitch"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Modifies attributes of an existing logical switch. Modifiable\nattributes include admin_state, replication_mode, switching_profile_ids\nand VLAN spec. You cannot modify the original transport_zone_id.\nThis api is now deprecated. Please use new api - PATCH /infra/segments/<segment-id>\n","parameters":[{"required":true,"type":"string","name":"lswitch-id","in":"path"},{"schema":{"$ref":"#/definitions/LogicalSwitch"},"required":true,"name":"LogicalSwitch","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Switching","Logical Switches"],"summary":"Update a Logical Switch","x-vmw-nsx-module":"LogicalSwitch","consumes":["application/json"],"operationId":"UpdateLogicalSwitch"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Removes a logical switch from the associated overlay or VLAN transport\nzone. By default, a logical switch cannot be deleted if there are logical\nports on the switch, or it is added to a NSGroup.\nCascade option can be used to delete all ports and the logical switch.\nDetach option can be used to delete the logical switch forcibly. This api is now deprecated.\nPlease use new api - /infra/segments/<segment-id>\n","parameters":[{"required":true,"type":"string","name":"lswitch-id","in":"path"},{"description":"Delete a Logical Switch and all the logical ports in it,\nif none of the logical ports have any attachment.\n","default":false,"required":false,"in":"query","type":"boolean","name":"cascade"},{"description":"Force delete a logical switch","default":false,"required":false,"in":"query","type":"boolean","name":"detach"}],"tags":["Management Plane API","Networking","Logical Switching","Logical Switches"],"summary":"Delete a Logical Switch","x-vmw-nsx-module":"LogicalSwitch","consumes":["application/json"],"operationId":"DeleteLogicalSwitch"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LogicalSwitch"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about the specified logical switch Id. This api is now deprecated. Please use new api - /infra/segments/<segment-id>","parameters":[{"required":true,"type":"string","name":"lswitch-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Switching","Logical Switches"],"summary":"Get Logical Switch associated with the provided id (lswitch-id)","x-vmw-nsx-module":"LogicalSwitch","consumes":["application/json"],"operationId":"GetLogicalSwitch"}},"/node/file-store?action=create_remote_directory":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"504":{"description":"Gateway Timeout"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Create a directory on the remote remote server. Supports only SFTP.\nYou must provide the remote server's SSH fingerprint. See the\nNSX Administration Guide for information and instructions\nabout finding the SSH fingerprint.\n","parameters":[{"schema":{"$ref":"#/definitions/CreateRemoteDirectoryProperties"},"required":true,"name":"CreateRemoteDirectoryProperties","in":"body"}],"tags":["System Administration","Configuration","Fabric","Nodes","File Store"],"summary":"Create directory in remote file server","x-vmw-nsx-module":"FileStoreModule","consumes":["application/json"],"operationId":"CreateRemoteDirectoryCreateRemoteDirectory"}},"/node/services/policy":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodePolicyServiceProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update service properties","parameters":[{"schema":{"$ref":"#/definitions/NodePolicyServiceProperties"},"required":true,"name":"NodePolicyServiceProperties","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Policy Service"],"summary":"Update service properties","x-vmw-nsx-module":"NodePolicyService","consumes":["application/json"],"operationId":"UpdatePolicyService"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodePolicyServiceProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read service properties","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Policy Service"],"summary":"Read service properties","x-vmw-nsx-module":"NodePolicyService","consumes":["application/json"],"operationId":"ReadPolicyService"}},"/firewall/excludelist?action=check_if_exists":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResourceReference"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Check if the object a member of the exclude list","parameters":[{"description":"Check all parents","default":false,"required":false,"in":"query","type":"boolean","name":"deep_check"},{"in":"query","description":"identifier of the object","required":true,"maxLength":64,"type":"string","name":"object_id"},{"enum":["NSGroup","LogicalPort","LogicalSwitch"],"description":"Object type of an entity","required":false,"in":"query","type":"string","name":"object_type"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Firewall"],"summary":"Check if the object a member of the exclude list","x-vmw-nsx-module":"ExcludeList","consumes":["application/json"],"operationId":"CheckMemberIfExists"}},"/upgrade/summary":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UpgradeSummary"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get upgrade summary","produces":["application/json"],"tags":["System Administration","Lifecycle Management","Upgrade","Status"],"summary":"Get upgrade summary","x-vmw-nsx-module":"Upgrade","consumes":["application/json"],"operationId":"GetUpgradeSummary"}},"/node/services/async_replicator?action=start":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the Async Replicator service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Async Replicator Service"],"summary":"Restart, start or stop the Async Replicator service","x-vmw-nsx-module":"NodeAsyncReplicatorService","consumes":["application/json"],"operationId":"CreateAsyncReplicatorServiceActionStart"}},"/node/services/syslog?action=start":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the syslog service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","Syslog"],"summary":"Restart, start or stop the syslog service","x-vmw-nsx-module":"NodeSyslogService","consumes":["application/json"],"operationId":"CreateSyslogServiceActionStart"}},"/logical-routers/{logical-router-id}/nat/rules":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/NatRule"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Add a NAT rule in a specific logical router.\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"schema":{"$ref":"#/definitions/NatRule"},"required":true,"name":"NatRule","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","NAT"],"summary":"Add a NAT rule in a specific logical router","x-vmw-nsx-module":"Nat","consumes":["application/json"],"operationId":"AddNatRule"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NatRuleListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns paginated list of all user defined NAT rules of the specific\nlogical router. If a rule_type is provided, only the given type of\nrules will be returned. If no rule_type is specified, the rule_type\nwill be defaulted to NATv4, i.e. only the NATv4 rules will be listed.\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"enum":["ALL","NATv4","NAT64"],"description":"Action type for getting NAT rules","required":false,"in":"query","type":"string","name":"rule_type"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","NAT"],"summary":"List NAT rules of the logical router","x-vmw-nsx-module":"Nat","consumes":["application/json"],"operationId":"ListNatRules"}},"/systemhealth/transport-nodes/{node-id}/container/agent/status":{"get":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/TnNodeAgentStatusListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get the containter status on given node","parameters":[{"required":true,"type":"string","name":"node-id","in":"path"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["System Administration","Monitoring","System Health","Container"],"summary":"Get the containter status on given node","x-vmw-nsx-module":"TnContainerStatus","consumes":["application/json"],"operationId":"ReadTnContainerAgentStatus"}},"/node/services/syslog":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read syslog service properties","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","Syslog"],"summary":"Read syslog service properties","x-vmw-nsx-module":"NodeSyslogService","consumes":["application/json"],"operationId":"ReadSyslogService"}},"/pools/ip-pools/{pool-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IpPool"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Modifies the specified IP address pool. Modifiable parameters include the\ndescription, display_name, and all subnet information.\n","parameters":[{"description":"IP pool ID","required":true,"type":"string","name":"pool-id","in":"path"},{"schema":{"$ref":"#/definitions/IpPool"},"required":true,"name":"IpPool","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Pool Management","IP Pools"],"summary":"Update an IP Pool","x-vmw-nsx-module":"Ipam","consumes":["application/json"],"operationId":"UpdateIpPool"},"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AllocationIpAddress"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"409":{"description":"Conflict"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Allocates or releases an IP address from the specified IP pool. To allocate\nan address, include ?action=ALLOCATE in the request and \"allocation_id\":null\nin the request body. When the request is successful, the response is\n\"allocation_id\": \"<ip-address>\", where <ip-address> is an IP address from\nthe specified pool. To release an IP address (return it back to the pool),\ninclude ?action=RELEASE in the request and \"allocation_id\":<ip-address> in\nthe request body, where <ip-address> is the address to be released. When the\nrequest is successful, the response is NULL. Tags, display_name and description\nattributes are not supported for AllocationIpAddress in this release.\n","parameters":[{"description":"IP pool ID","required":true,"type":"string","name":"pool-id","in":"path"},{"schema":{"$ref":"#/definitions/AllocationIpAddress"},"required":true,"name":"AllocationIpAddress","in":"body"},{"enum":["ALLOCATE","RELEASE"],"description":"Specifies allocate or release action","required":true,"in":"query","type":"string","name":"action"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Pool Management","IP Pools"],"summary":"Allocate or Release an IP Address from a Pool","x-vmw-nsx-module":"Ipam","consumes":["application/json"],"operationId":"AllocateOrReleaseFromIpPool"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IpPool"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about the specified IP address pool.","parameters":[{"description":"IP pool ID","required":true,"type":"string","name":"pool-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Pool Management","IP Pools"],"summary":"Read IP Pool","x-vmw-nsx-module":"Ipam","consumes":["application/json"],"operationId":"ReadIpPool"},"delete":{"responses":{"200":{"description":"OK"},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Deletes the specified IP address pool. By default, if the IpPool is used in other configurations (such as transport node template), it won't be deleted. In such situations, pass \"force=true\" as query param to force delete the IpPool","parameters":[{"description":"IP pool ID","required":true,"type":"string","name":"pool-id","in":"path"},{"default":false,"description":"Force delete the resource even if it is being used somewhere\n","type":"boolean","name":"force","in":"query"}],"tags":["System Administration","Configuration","Fabric","Pool Management","IP Pools"],"summary":"Delete an IP Pool","x-vmw-nsx-module":"Ipam","consumes":["application/json"],"operationId":"DeleteIpPool"}},"/cluster/backups/config":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BackupConfiguration"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Configure file server and timers for automated backup.\nIf secret fields are omitted (password, passphrase)\nthen use the previously set value.\n","parameters":[{"schema":{"$ref":"#/definitions/BackupConfiguration"},"required":true,"name":"BackupConfiguration","in":"body"},{"enum":["GLOBAL_MANAGER","LOCAL_MANAGER","LOCAL_LOCAL_MANAGER","NSX_INTELLIGENCE"],"description":"Frame type","default":"LOCAL_LOCAL_MANAGER","required":false,"in":"query","type":"string","name":"frame_type"},{"description":"Site ID","default":"localhost","required":false,"in":"query","type":"string","name":"site_id"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Backup Restore Management","Backup"],"summary":"Configure backup","x-vmw-nsx-module":"BackupConfiguration","consumes":["application/json"],"operationId":"ConfigureBackupConfig"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BackupConfiguration"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get a configuration of a file server and timers for automated backup.\nFields that contain secrets (password, passphrase) are not returned.\n","produces":["application/json"],"tags":["System Administration","Lifecycle Management","Backup Restore Management","Backup"],"summary":"Get backup configuration","x-vmw-nsx-module":"BackupConfiguration","consumes":["application/json"],"operationId":"GetBackupConfig"}},"/aaa/features-with-properties":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FeaturePermissionListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"List features\n","produces":["application/json"],"tags":["System Administration","Settings","User Management","Roles"],"summary":"List feature permissions","x-vmw-nsx-module":"AAA","consumes":["application/json"],"operationId":"ListFeatures"}},"/traceflows/{traceflow-id}/observations":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TraceflowObservationListResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get observations for the Traceflow round","parameters":[{"required":true,"type":"string","name":"traceflow-id","in":"path"},{"description":"Observations having the given component name will be listed.","required":false,"type":"string","name":"component_name","in":"query"},{"enum":["PHYSICAL","LR","LS","DFW","BRIDGE","EDGE_TUNNEL","EDGE_HOSTSWITCH","FW_BRIDGE","EDGE_RTEP_TUNNEL","LOAD_BALANCER","NAT","IPSEC","SERVICE_INSERTION","VMC","SPOOFGUARD","EDGE_FW","DLB","ANTREA_SPOOFGUARD","ANTREA_LB","ANTREA_ROUTING","ANTREA_DFW","ANTREA_FORWARDING","HOST_SWITCH","UNKNOWN"],"description":"Observations having the given component type will be listed.","required":false,"in":"query","type":"string","name":"component_type"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"enum":["TraceflowObservationForwarded","TraceflowObservationDropped","TraceflowObservationDelivered","TraceflowObservationReceived","TraceflowObservationForwardedLogical","TraceflowObservationDroppedLogical","TraceflowObservationReceivedLogical","TraceflowObservationReplicationLogical","TraceflowObservationRelayedLogical"],"description":"The type of observations that will be listed.","required":false,"in":"query","type":"string","name":"resource_type"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"description":"Observations having the given transport node name will be listed.","required":false,"type":"string","name":"transport_node_name","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Troubleshooting And Monitoring","Traceflow"],"summary":"Get observations for the Traceflow round","x-vmw-nsx-module":"Traceflow","consumes":["application/json"],"operationId":"GetTraceflowObservations"}},"/trust-management/crls/{crl-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Crl"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Updates an existing CRL.","parameters":[{"description":"ID of CRL to update","required":true,"type":"string","name":"crl-id","in":"path"},{"schema":{"$ref":"#/definitions/Crl"},"required":true,"name":"Crl","in":"body"}],"produces":["application/json"],"tags":["System Administration","Settings","Certificates","CSR"],"summary":"Update CRL for the Given CRL ID","x-vmw-nsx-module":"CertificateManager","consumes":["application/json"],"operationId":"UpdateCrl"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Crl"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about the specified CRL. For additional information,\ninclude the ?details=true modifier at the end of the request URI.\n","parameters":[{"description":"ID of CRL to read","required":true,"type":"string","name":"crl-id","in":"path"},{"description":"whether to expand the pem data and show all its details","default":false,"required":false,"in":"query","type":"boolean","name":"details"}],"produces":["application/json"],"tags":["System Administration","Settings","Certificates","CSR"],"summary":"Show CRL Data for the Given CRL ID","x-vmw-nsx-module":"CertificateManager","consumes":["application/json"],"operationId":"GetCrl"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Deletes an existing CRL.","parameters":[{"description":"ID of CRL to delete","required":true,"type":"string","name":"crl-id","in":"path"}],"tags":["System Administration","Settings","Certificates","CSR"],"summary":"Delete a CRL","x-vmw-nsx-module":"CertificateManager","consumes":["application/json"],"operationId":"DeleteCrl"}},"/trust-management/csrs/{csr-id}?action=self_sign":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/Certificate"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Self-signs the previously generated CSR. This action is similar to the\nimport certificate action, but instead of using a public certificate signed\nby a CA, the self_sign POST action uses a certificate that is signed with\nNSX's own private key.\nFor validity of non-CA certificates, if a value greater than 825 days is\nprovided, it will be set to 825 days. No limit is set for CA certificates.\n","parameters":[{"description":"CSR this certificate is associated with","required":true,"type":"string","name":"csr-id","in":"path"},{"description":"Number of days the certificate will be valid, default 825 days","format":"int64","default":825,"required":true,"maximum":10000,"minimum":1,"in":"query","type":"integer","name":"days_valid"}],"produces":["application/json"],"tags":["System Administration","Settings","Certificates","CSR"],"summary":"Self-Sign the CSR","x-vmw-nsx-module":"CertificateManager","consumes":["application/json"],"operationId":"SelfSignCertificate"}},"/aaa/registration-token":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RegistrationToken"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"The privileges of the registration token will be the same as the caller.","produces":["application/json"],"tags":["System Administration","Settings","User Management","Access Token"],"summary":"Create registration access token","x-vmw-nsx-module":"RegistrationTokenEndPoint","consumes":["application/json"],"operationId":"CreateRegistrationToken"}},"/trust-management/certificates/{cert-id}":{"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Removes the specified certificate. The private key associated with the\ncertificate is also deleted.\n","parameters":[{"description":"ID of certificate to delete","required":true,"type":"string","name":"cert-id","in":"path"}],"tags":["System Administration","Settings","Certificates","Certificate"],"summary":"Delete Certificate for the Given Certificate ID","x-vmw-nsx-module":"CertificateManager","consumes":["application/json"],"operationId":"DeleteCertificate"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Certificate"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information for the specified certificate ID, including the\ncertificate's UUID; resource_type (for example, certificate_self_signed,\ncertificate_ca, or certificate_signed); pem_encoded data; and history of the\ncertificate (who created or modified it and when). For additional\ninformation, include the ?details=true modifier at the end of the request\nURI.\n","parameters":[{"description":"ID of certificate to read","required":true,"type":"string","name":"cert-id","in":"path"},{"description":"whether to expand the pem data and show all its details","default":false,"required":false,"in":"query","type":"boolean","name":"details"}],"produces":["application/json"],"tags":["System Administration","Settings","Certificates","Certificate"],"summary":"Show Certificate Data for the Given Certificate ID","x-vmw-nsx-module":"CertificateManager","consumes":["application/json"],"operationId":"GetCertificate"}},"/nvds-urt/topology/{precheck-id}":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UpgradeTopology"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Recommmended topology","parameters":[{"required":true,"type":"string","name":"precheck-id","in":"path"},{"description":"cluster identifier","required":false,"type":"string","name":"cluster_id","in":"query"},{"description":"vCenter identifier","required":false,"type":"string","name":"compute_manager_id","in":"query"},{"description":"Flag to indicate if VdsTopology should contain VDS configuration","required":false,"type":"boolean","name":"show_vds_config","in":"query"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Transport Nodes"],"summary":"Recommmended topology","x-vmw-nsx-module":"NvdsUpgradeReadinessCheck","consumes":["application/json"],"operationId":"GetRecommendedVdsTopology"}},"/node/services/controller?action=stop":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the controller service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Controller Service"],"summary":"Restart, start or stop the controller service","x-vmw-nsx-module":"NodeControllerServerService","consumes":["application/json"],"operationId":"CreateControllerServerServiceActionStop"}},"/aaa/roles-with-feature-permissions":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RoleWithFeaturesListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get information about all roles with features and their permissions","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["System Administration","Settings","User Management","Roles"],"summary":"Get information about all roles with features and their permissions","x-vmw-nsx-module":"AAA","consumes":["application/json"],"operationId":"ListRolesInfo"}},"/manual-health-checks/{manual-health-check-id}":{"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete an existing manual health check by ID.","parameters":[{"required":true,"type":"string","name":"manual-health-check-id","in":"path"}],"tags":["Management Plane API","Troubleshooting And Monitoring","Healthcheck"],"summary":"Delete an existing manual health check","x-vmw-nsx-module":"HealthCheck","consumes":["application/json"],"operationId":"DeleteManualHealthCheck"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ManualHealthCheck"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get an existing manual health check by health check ID.","parameters":[{"required":true,"type":"string","name":"manual-health-check-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Troubleshooting And Monitoring","Healthcheck"],"summary":"Get an existing manual health check","x-vmw-nsx-module":"HealthCheck","consumes":["application/json"],"operationId":"GetManualHealthCheck"}},"/ipv6/nd-ra-profiles":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NDRAProfile"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Adds a new NDRAProfile\n","parameters":[{"schema":{"$ref":"#/definitions/NDRAProfile"},"required":true,"name":"NDRAProfile","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Routing Configuration"],"summary":"Create a new NDRA Profile","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"CreateNDRAProfile"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NDRAProfileListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns all IPv6 NDRA Profiles.\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Routing Configuration"],"summary":"Read All IPV6 NDRA Profiles","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"ListNDRAProfiles"}},"/node/services/idps-reporting/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read the idps-reporting service status","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Idps Reporting Service"],"summary":"Read the idps-reporting service status","x-vmw-nsx-module":"IdpsReportingService","consumes":["application/json"],"operationId":"ReadIdpsReportingServiceStatus"}},"/dhcp/servers/{server-id}/ipv6-static-bindings":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/DhcpV6StaticBinding"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Create a static binding for a logical DHCP IPv6 server.","parameters":[{"required":true,"type":"string","name":"server-id","in":"path"},{"schema":{"$ref":"#/definitions/DhcpV6StaticBinding"},"required":true,"name":"DhcpV6StaticBinding","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","DHCP"],"summary":"Create a static binding for a DHCP IPv6 server","x-vmw-nsx-module":"Dhcp","consumes":["application/json"],"operationId":"CreateDhcpV6StaticBinding"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DhcpV6StaticBindingListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Return a paginated list of a static bindings of a given logical DHCP IPv6 server.\n","parameters":[{"required":true,"type":"string","name":"server-id","in":"path"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","DHCP"],"summary":"Get a paginated list of a DHCP IPv6 server's static bindings","x-vmw-nsx-module":"Dhcp","consumes":["application/json"],"operationId":"ListDhcpV6StaticBindings"}},"/cluster/{node-id}":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ClusterNodeInfo"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"description":"Service Unavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about the specified NSX cluster node.","parameters":[{"required":true,"type":"string","name":"node-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","NSX Managers","Clusters","Cluster Configuration"],"summary":"Read cluster node configuration","x-vmw-nsx-module":"ClusterManagement","consumes":["application/json"],"operationId":"GetClusterNodeConfig"}},"/repository/bundles/upload-allowed":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BundleUploadPermission"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Checks whether bundle upload is allowed on given node for given appliance.\nThere are different kinds of checks for different appliances. Some of the\nchecks for Intelligence appliance are as follows:\n1. Is bundle upload-allowed on given node\n2. Is bundle upload already in-progress\n","parameters":[{"enum":["SAMPLE","ALB_CONTROLLER","INTELLIGENCE"],"description":"Name of the appliance","required":true,"in":"query","type":"string","name":"product"}],"produces":["application/json"],"tags":["System Administration","Configuration","NSX Intelligence","Repository","Bundles"],"summary":"Checks bundle upload permissions","x-vmw-nsx-module":"FileUploadFramework","consumes":["application/json"],"operationId":"GetBundleUploadPermissions"}},"/telemetry/agreement":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TelemetryAgreement"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Set telemetry agreement information.","parameters":[{"schema":{"$ref":"#/definitions/TelemetryAgreement"},"required":true,"name":"TelemetryAgreement","in":"body"}],"produces":["application/json"],"tags":["System Administration","Settings","Customer Experience Improvement","Telemetry"],"summary":"Set telemetry agreement information","x-vmw-nsx-module":"TelemetryConfig","consumes":["application/json"],"operationId":"UpdateTelemetryAgreement"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TelemetryAgreement"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns telemetry agreement information.","produces":["application/json"],"tags":["System Administration","Settings","Customer Experience Improvement","Telemetry"],"summary":"Returns telemetry agreement information","x-vmw-nsx-module":"TelemetryConfig","consumes":["application/json"],"operationId":"GetTelemetryAgreement"}},"/dns/forwarders/{forwarder-id}?action=enable":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Enable the DNS forwarder if the forwarder is currently disabled. If the\nDNS forwarder is already enabled, the forwarder will not be re-enabled.\n\nPlease note, once a DNS forwarder is disabled then enabled, the previous\nDNS forwarder statistics counters will be reset.\n","parameters":[{"required":true,"type":"string","name":"forwarder-id","in":"path"}],"tags":["Management Plane API","Networking","Services","DNS"],"summary":"Enable the DNS forwarder.","x-vmw-nsx-module":"DnsForwarder","consumes":["application/json"],"operationId":"EnableDnsForwarder"}},"/sites/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FederationStatus"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"description":"Service Unavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get overall status of the federation, including stub status","produces":["application/json"],"tags":["System Administration","Configuration","Site Management"],"summary":"Get overall status of the federation, including stub status","x-vmw-nsx-module":"SiteManagerModule","consumes":["application/json"],"operationId":"GetFederationStatus"}},"/node/intelligence/form-factors":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IntelligenceFormFactors"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about all form factors available for Napp cluster\n","produces":["application/json"],"tags":["System Administration","Configuration","NSX Intelligence","Form Factors"],"summary":"List available Napp appliance form factors","x-vmw-nsx-module":"IntelligenceNodeFormFactors","consumes":["application/json"],"operationId":"ListIntelligenceFormFactors"}},"/ns-groups/{ns-group-id}/member-types":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EffectiveMemberTypeListResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns member types for a specified NSGroup including child NSGroups.\nThis considers static members and members added via membership criteria only\n","parameters":[{"description":"NSGroup Id","required":true,"type":"string","name":"ns-group-id","in":"path"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Grouping Objects","NS Groups"],"summary":"Get member types from NSGroup","x-vmw-nsx-module":"NSGroup","consumes":["application/json"],"operationId":"GetMemberTypes"}},"/transport-zones/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/HeatMapTransportNodesAggregateStatus"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get high-level summary of a transport zone. The service layer does not support source = realtime or cached.","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Transport Zones"],"summary":"Get high-level summary of a transport zone. The service layer does not support source = realtime or cached.","x-vmw-nsx-module":"Heatmap","consumes":["application/json"],"operationId":"GetAllTransportZoneStatus"}},"/node/services/syslog/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read syslog service status","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","Syslog"],"summary":"Read syslog service status","x-vmw-nsx-module":"NodeSyslogService","consumes":["application/json"],"operationId":"ReadSyslogServiceStatus"}},"/licenses":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/License"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"This will add a license key to the system.\nThe API supports adding only one license key for each license edition\ntype - Standard, Advanced or Enterprise. If a new license key is tried\nto add for an edition for which the license key already exists,\nthen this API will return an error.\n","parameters":[{"schema":{"$ref":"#/definitions/License"},"required":true,"name":"License","in":"body"}],"produces":["application/json"],"tags":["System Administration","Settings","Licenses"],"summary":"Add a new license key","x-vmw-nsx-module":"License","consumes":["application/json"],"operationId":"CreateLicense"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LicensesListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns all licenses.\n","produces":["application/json"],"tags":["System Administration","Settings","Licenses"],"summary":"Get all licenses","x-vmw-nsx-module":"License","consumes":["application/json"],"operationId":"GetLicenses"}},"/intelligence/nodes/deployments/{node-id}":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IntelligenceClusterNodeVMDeploymentRequest"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"description":"Bad Request"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns deployment request information for a specific attempted\ndeployment of a cluster node VM.\n","parameters":[{"required":true,"type":"string","name":"node-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","NSX Intelligence","Deployments"],"summary":"Returns info for a Intelligence cluster node VM auto-deployment attempt","x-vmw-nsx-module":"NsxIntelligenceDeployment","consumes":["application/json"],"operationId":"ReadPaceClusterNodeVMDeploymentRequest"}},"/logical-switches/{logical-switch-id}/inter-site-forwarder/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/L2ForwarderStatus"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns status per transport node of the l2 forwarder on logical switch.\n","parameters":[{"required":true,"type":"string","name":"logical-switch-id","in":"path"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"}],"produces":["application/json"],"tags":["Federation","Inter-Sites"],"summary":"Get L2 forwarder status","x-vmw-nsx-module":"AggSvcL2Forwarder","consumes":["application/json"],"operationId":"GetL2ForwarderStatus"}},"/trust-management/principal-identities?action=update_certificate":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PrincipalIdentity"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update a principal identity's certificate\n","parameters":[{"schema":{"$ref":"#/definitions/UpdatePrincipalIdentityCertificateRequest"},"required":true,"name":"UpdatePrincipalIdentityCertificateRequest","in":"body"}],"produces":["application/json"],"tags":["System Administration","Settings","User Management","Principal Identity"],"summary":"Update a principal identity's certificate","x-vmw-nsx-module":"CertificateManager","consumes":["application/json"],"operationId":"UpdatePrincipalIdentityCertificate"}},"/node/services/applianceproxy?action=stop":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the Appliance Proxy Service","produces":["application/json"],"tags":["Management Plane API","NSX Component Administration","Appliance Management"],"summary":"Restart, start or stop the Appliance Proxy Service","x-vmw-nsx-module":"NodeApplProxy","consumes":["application/json"],"operationId":"CreateApplProxyActionStop"}},"/node/services/node-stats?action=restart":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the NSX node-stats service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Node Stats Service"],"summary":"Restart, start or stop the NSX node-stats service","x-vmw-nsx-module":"NodeNodeStatsService","consumes":["application/json"],"operationId":"CreateNodeStatsServiceActionRestart"}},"/node/services/migration-coordinator?action=stop":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the migration coordinator service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Migration Coordinator Service"],"summary":"Restart, start or stop the migration coordinator service","x-vmw-nsx-module":"NodeMigrationCoordinatorService","consumes":["application/json"],"operationId":"CreateMigrationCoordinatorServiceActionStop"}},"/firewall/stats?action=reset":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Sets firewall rule statistics counter to zero. This operation is supported\nfor given category, for example: L3DFW i.e. for all layer3 firewall\n(transport nodes only) rules or L3EDGE i.e. for all layer3 edge firewall\n(edge nodes only) rules or L3BRIDGEPORT i.e. for all layer3 bridge port firewall\n(bridge ports only) rules.\n","parameters":[{"enum":["L3DFW","L3EDGE","L3BRIDGEPORT"],"description":"Aggregation statistic category","required":true,"in":"query","type":"string","name":"category"}],"tags":["Management Plane API","Security","Services","Firewall"],"summary":"Reset firewall rule statistics","x-vmw-nsx-module":"FirewallStatsRule","consumes":["application/json"],"operationId":"ResetFirewallRuleStats"}},"/error-resolver?action=resolve_error":{"post":{"responses":{"204":{"description":"No Content"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Invokes the corresponding error resolver for the\ngiven error(s) present in the payload\n","parameters":[{"schema":{"$ref":"#/definitions/ErrorResolverMetadataList"},"required":true,"name":"ErrorResolverMetadataList","in":"body"}],"tags":["System Administration","Monitoring","Error Resolver"],"summary":"Resolves the error","x-vmw-nsx-module":"ErrorResolver","consumes":["application/json"],"operationId":"ResolveError"}},"/systemhealth/plugins/{plugin-id}/files/{file-name}/data":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/PluginFileProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"409":{"description":"Conflict"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Upload a plugin File to MP","parameters":[{"description":"Plugin filename","required":true,"type":"string","name":"file-name","in":"path"},{"description":"Plugin ID","required":true,"type":"string","name":"plugin-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Monitoring","System Health","Plugins"],"summary":"Upload a plugin File to MP","x-vmw-nsx-module":"SystemHealthPlugin","consumes":["multipart/form-data"],"operationId":"CreatePluginFile"}},"/node/services/syslog?action=stop":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the syslog service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","Syslog"],"summary":"Restart, start or stop the syslog service","x-vmw-nsx-module":"NodeSyslogService","consumes":["application/json"],"operationId":"CreateSyslogServiceActionStop"}},"/aaa/role-bindings/{binding-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RoleBinding"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"This API is used to update a user/group any role(s) of choice.\nUser name is dealt case-insensitively.\n","parameters":[{"description":"User/Group's id","required":true,"type":"string","name":"binding-id","in":"path"},{"schema":{"$ref":"#/definitions/RoleBinding"},"required":true,"name":"RoleBinding","in":"body"}],"produces":["application/json"],"tags":["System Administration","Settings","User Management","Roles"],"summary":"Update User or Group's roles","x-vmw-nsx-module":"AAA","consumes":["application/json"],"operationId":"UpdateRoleBinding"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete the user/group's role assignment.\n","parameters":[{"description":"User/Group's id","required":true,"type":"string","name":"binding-id","in":"path"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Identity source ID","required":false,"type":"string","name":"identity_source_id","in":"query"},{"enum":["VIDM","LDAP","OIDC"],"description":"Identity source type","required":false,"in":"query","type":"string","name":"identity_source_type"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"User/Group name","required":false,"type":"string","name":"name","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"description":"Role ID","required":false,"type":"string","name":"role","in":"query"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"enum":["remote_user","remote_group","local_user","principal_identity"],"description":"Type","required":false,"in":"query","type":"string","name":"type"}],"tags":["System Administration","Settings","User Management","Roles"],"summary":"Delete user/group's roles assignment","x-vmw-nsx-module":"AAA","consumes":["application/json"],"operationId":"DeleteRoleBinding"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RoleBinding"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get user/group's role information","parameters":[{"description":"User/Group's id","required":true,"type":"string","name":"binding-id","in":"path"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Identity source ID","required":false,"type":"string","name":"identity_source_id","in":"query"},{"enum":["VIDM","LDAP","OIDC"],"description":"Identity source type","required":false,"in":"query","type":"string","name":"identity_source_type"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"User/Group name","required":false,"type":"string","name":"name","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"description":"Role ID","required":false,"type":"string","name":"role","in":"query"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"enum":["remote_user","remote_group","local_user","principal_identity"],"description":"Type","required":false,"in":"query","type":"string","name":"type"}],"produces":["application/json"],"tags":["System Administration","Settings","User Management","Roles"],"summary":"Get user/group's role information","x-vmw-nsx-module":"AAA","consumes":["application/json"],"operationId":"GetRoleBinding"}},"/fabric/container-clusters/{container-cluster-id}":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ContainerCluster"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about a specific container cluster","parameters":[{"required":true,"type":"string","name":"container-cluster-id","in":"path"}],"produces":["application/json"],"tags":["Policy","Inventory","Containers","Container Clusters"],"summary":"Return a container cluster","x-vmw-nsx-module":"InventoryContainerObj","consumes":["application/json"],"operationId":"GetContainerCluster"}},"/node/services/idps-reporting?action=stop":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the idps-reporting service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Idps Reporting Service"],"summary":"Restart, start or stop the idps-reporting service","x-vmw-nsx-module":"IdpsReportingService","consumes":["application/json"],"operationId":"CreateIdpsReportingServiceActionStop"}},"/aaa/role-bindings?action=delete_stale_bindings":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete all stale role assignments","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Identity source ID","required":false,"type":"string","name":"identity_source_id","in":"query"},{"enum":["VIDM","LDAP","OIDC"],"description":"Identity source type","required":false,"in":"query","type":"string","name":"identity_source_type"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"User/Group name","required":false,"type":"string","name":"name","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"description":"Role ID","required":false,"type":"string","name":"role","in":"query"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"enum":["remote_user","remote_group","local_user","principal_identity"],"description":"Type","required":false,"in":"query","type":"string","name":"type"}],"tags":["System Administration","Settings","User Management","Roles"],"summary":"Delete all stale role assignments","x-vmw-nsx-module":"AAA","consumes":["application/json"],"operationId":"DeleteAllStaleRoleBindings"}},"/trust-management/token-principal-identities/{principal-identity-id}":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TokenBasedPrincipalIdentity"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get a stored token-based principal identity\n","parameters":[{"description":"ID of the principal identity to get","required":true,"type":"string","name":"principal-identity-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Settings","User Management","Principal Identity"],"summary":"Get a token-based principal identity","x-vmw-nsx-module":"CertificateManager","consumes":["application/json"],"operationId":"GetTokenBasedPrincipalIdentity"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete a token-based principal identity.\n","parameters":[{"description":"Unique id of the token-based principal identity to delete","required":true,"type":"string","name":"principal-identity-id","in":"path"}],"tags":["System Administration","Settings","User Management","Principal Identity"],"summary":"Delete a token-based principal identity","x-vmw-nsx-module":"CertificateManager","consumes":["application/json"],"operationId":"DeleteTokenBasedPrincipalIdentity"}},"/loadbalancer/services/{service-id}/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LbServiceStatus"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the status of the given load balancer service.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"description":"Flag to indicate whether include detail information","default":false,"required":false,"in":"query","type":"boolean","name":"include_instance_details"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"},{"description":"The UUIDs of transport nodes","required":false,"type":"string","name":"transport_node_ids","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Get the status of the given load balancer service","x-vmw-nsx-module":"AggSvcLb","consumes":["application/json"],"operationId":"GetLoadBalancerServiceStatus"}},"/fabric/virtual-switches":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/VirtualSwitchListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about all virtual switches based on the\nrequest parameters.\n","parameters":[{"description":"Local Id of the virtual switch","required":false,"type":"string","name":"cm_local_id","in":"query"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Discovered node ID","required":false,"type":"string","name":"discovered_node_id","in":"query"},{"description":"Display name of the virtual switch","required":false,"type":"string","name":"display_name","in":"query"},{"description":"External id of the virtual switch","required":false,"type":"string","name":"external_id","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"ID of the compute manager","required":false,"type":"string","name":"origin_id","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"description":"UUID of the switch","required":false,"type":"string","name":"uuid","in":"query"}],"produces":["application/json"],"tags":["Policy","Inventory","Virtual Switches"],"summary":"Return the List of Virtual Switches","x-vmw-nsx-module":"InventoryCmObj","consumes":["application/json"],"operationId":"ListVirtualSwitches"}},"/pktcap/sessions":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PacketCaptureSessionList"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get the information of all packet capture sessions.\n","produces":["application/json"],"tags":["Management Plane API","Troubleshooting And Monitoring","Packet Capture"],"summary":"Get the information of all packet capture sessions","x-vmw-nsx-module":"PacketCapture","consumes":["application/json"],"operationId":"ListPacketCaptureSessions"}},"/pktcap/session/{session-id}?action=restart":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PacketCaptureSession"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart the packet capture session\n","parameters":[{"description":"Packet capture session id","required":true,"type":"string","name":"session-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Troubleshooting And Monitoring","Packet Capture"],"summary":"Restart the packet capture session","x-vmw-nsx-module":"PacketCapture","consumes":["application/json"],"operationId":"RestartPacketCaptureSession"}},"/node/services/ui-service":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read ui service properties","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","User Interface Service"],"summary":"Read ui service properties","x-vmw-nsx-module":"NodeUiServiceService","consumes":["application/json"],"operationId":"ReadNsxUiServiceService"}},"/node/users":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeUserPropertiesListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the list of users configured to log in to the NSX appliance.\n","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","User Management","Users"],"summary":"List node users","x-vmw-nsx-module":"NodeUsers","consumes":["application/json"],"operationId":"ListNodeUsers"}},"/systemhealth/profiles":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/SystemHealthAgentProfile"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Create a system health profile.\n","parameters":[{"schema":{"$ref":"#/definitions/SystemHealthAgentProfile"},"required":true,"name":"SystemHealthAgentProfile","in":"body"}],"produces":["application/json"],"tags":["System Administration","Monitoring","System Health","Profiles"],"summary":"Create a system health profile","x-vmw-nsx-module":"SystemHealthAgent","consumes":["application/json"],"operationId":"CreateSystemHealthAgentProfile"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SystemHealthAgentProfileListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"List all system health profiles.\n","produces":["application/json"],"tags":["System Administration","Monitoring","System Health","Profiles"],"summary":"List all system health profiles","x-vmw-nsx-module":"SystemHealthAgent","consumes":["application/json"],"operationId":"ListSystemHealthAgentProfiles"}},"/fabric/container-cluster-nodes/{container-cluster-node-id}":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ContainerClusterNode"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about a specific container cluster node.","parameters":[{"required":true,"type":"string","name":"container-cluster-node-id","in":"path"}],"produces":["application/json"],"tags":["Policy","Inventory","Containers","Container Clusters"],"summary":"Return a container cluster node","x-vmw-nsx-module":"InventoryContainerObj","consumes":["application/json"],"operationId":"GetContainerClusterNode"}},"/logical-switches/state":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LogicalSwitchStateListResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns a list of logical switches states that have realized state as provided\nas query parameter. This api is now deprecated. Please use new api -\npolicy/api/v1/infra/realized-state/realized-entities?intent_path={{intent-path}}\n","parameters":[{"enum":["PENDING","IN_PROGRESS","PARTIAL_SUCCESS","SUCCESS"],"description":"Realized state of logical switches","required":false,"in":"query","type":"string","name":"status"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Switching","Logical Switches"],"summary":"List logical switches by realized state","x-vmw-nsx-module":"LogicalSwitch","consumes":["application/json"],"operationId":"ListLogicalSwitchesByState"}},"/service-configs/{config-set-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ServiceConfig"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Updates the specified ServiceConfig.\n","parameters":[{"description":"service config Id","required":true,"type":"string","name":"config-set-id","in":"path"},{"schema":{"$ref":"#/definitions/ServiceConfig"},"required":true,"name":"ServiceConfig","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Security","Service Configuration"],"summary":"Update service config","x-vmw-nsx-module":"ServiceConfig","consumes":["application/json"],"operationId":"UpdateServiceConfig"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ServiceConfig"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about the specified Service Config.\n","parameters":[{"description":"Service Config Id","required":true,"type":"string","name":"config-set-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Security","Service Configuration"],"summary":"Read Service Config","x-vmw-nsx-module":"ServiceConfig","consumes":["application/json"],"operationId":"ReadServiceConfig"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Deletes the specified service config\n","parameters":[{"description":"service Ccnfig Id","required":true,"type":"string","name":"config-set-id","in":"path"}],"tags":["Management Plane API","Security","Service Configuration"],"summary":"Delete Service Config","x-vmw-nsx-module":"ServiceConfig","consumes":["application/json"],"operationId":"DeleteServiceConfig"}},"/trust-management/crls":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/CrlList"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about all CRLs. For additional information, include the\n?details=true modifier at the end of the request URI.\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"whether to expand the pem data and show all its details","default":false,"required":false,"in":"query","type":"boolean","name":"details"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"enum":["cluster_api_certificate"],"description":"Type of certificate to return","required":false,"in":"query","type":"string","name":"type"}],"produces":["application/json"],"tags":["System Administration","Settings","Certificates","CSR"],"summary":"Return All Added CRLs","x-vmw-nsx-module":"CertificateManager","consumes":["application/json"],"operationId":"GetCrls"}},"/mirror-sessions/{mirror-session-id}/mirror-stack-status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MirrorStackStatusListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get the mirror stack status on given remote L3 mirror session","parameters":[{"required":true,"type":"string","name":"mirror-session-id","in":"path"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Troubleshooting And Monitoring","Port Mirroring"],"summary":"Get the mirror stack status on given remote L3 mirror session","x-vmw-nsx-module":"PortMirroring","consumes":["application/json"],"operationId":"GetMirrorStackStatus"}},"/transport-zones/{zone-id}/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/HeatMapTransportZoneStatus"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get high-level summary of a transport zone","parameters":[{"description":"ID of transport zone","required":true,"type":"string","name":"zone-id","in":"path"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Transport Zones"],"summary":"Get high-level summary of a transport zone","x-vmw-nsx-module":"Heatmap","consumes":["application/json"],"operationId":"GetHeatmapTransportZoneStatus"}},"/dhcp/servers/{server-id}/leases":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DhcpLeases"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get specific leases of a given dhcp server. As a dhcp server could manage\nmillions of leases, the API has to limit the number of the returned\nleases via two mutually-excluded request parameters, i.e. \"pool_id\" and\n\"address\". Either a \"pool_id\" or an \"address\" can be provided, but not both\nin a same call.\n\nIf a \"pool_id\" is specified, the leases of the specific pool are returned.\nIf an \"address\" is specified, only the lease(s) represented y this address\nis(are) returned. The \"address\" can be a single IP, an ip-range, or a mac\naddress.\n","parameters":[{"required":true,"type":"string","name":"server-id","in":"path"},{"description":"can be an ip address, or an ip range, or a mac address","required":false,"type":"string","name":"address","in":"query"},{"description":"The uuid of dhcp ip pool","required":false,"type":"string","name":"pool_id","in":"query"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"}],"produces":["application/json"],"tags":["Management Plane API","Services","DHCP"],"summary":"Get specific leases of a given dhcp server","x-vmw-nsx-module":"AggSvcDhcp","consumes":["application/json"],"operationId":"GetDhcpLeaseInfo"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete a single DHCP lease entry specified by ip and mac.\n\nThe DHCP server matches the DHCP lease with the given ip address and\nthe mac address. The matched lease entry will be deleted. If no lease\nmatches, the request is ignored.\n\nThe DHCP lease to be deleted will be removed by the system from both active\nand standby node. The system will report error if the DHCP lease could not\nbe removed from both nodes. If the DHCP lease could not be removed on either\nnode, please check the DHCP server status. Once the DHCP server status is\nUP, please invoke the deletion API again to ensure the lease gets deleted\nfrom both nodes.\n","parameters":[{"required":true,"type":"string","name":"server-id","in":"path"},{"description":"IPv4 or IPv6 address","format":"ip","required":true,"in":"query","type":"string","name":"ip"},{"description":"MAC Address","format":"mac-address","required":true,"in":"query","type":"string","name":"mac"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","DHCP"],"summary":"Delete a single DHCP lease entry specified by ip and mac.","x-vmw-nsx-module":"Dhcp","consumes":["application/json"],"operationId":"DeleteADhcpLease"}},"/bridge-endpoint-profiles":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/BridgeEndpointProfile"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Creates a Bridge Endpoint Profile. Profile contains edge cluster id,\nindexes of the member nodes, fialover mode and high availability mode\nfor a Bridge EndPoint\n","parameters":[{"schema":{"$ref":"#/definitions/BridgeEndpointProfile"},"required":true,"name":"BridgeEndpointProfile","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Bridging","Bridge Endpoint Profiles"],"summary":"Create a Bridge Endpoint Profile","x-vmw-nsx-module":"BridgeEndpointProfile","consumes":["application/json"],"operationId":"CreateBridgeEndpointProfile"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BridgeEndpointProfileListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about all configured bridge endoint profiles\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Edge Cluster Identifier","required":false,"type":"string","name":"edge_cluster_id","in":"query"},{"required":false,"type":"string","name":"failover_mode","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Bridging","Bridge Endpoint Profiles"],"summary":"List All Bridge Endpoint Profiles","x-vmw-nsx-module":"BridgeEndpointProfile","consumes":["application/json"],"operationId":"ListBridgeEndpointProfiles"}},"/migration/mp-to-policy/cancel":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"This will cancel the on-going promotion and system will be restored to original state\nas before promotion.\n","tags":["System Administration","Lifecycle Management","Migration","Plan"],"summary":"Cancel migration","x-vmw-nsx-module":"MPPolicyMigration","consumes":["application/json"],"operationId":"CancelPromotion"}},"/cluster/{target-node-id}/{target-uri}":{"put":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"504":{"description":"Gateway Timeout"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Invoke PUT request on target cluster node","parameters":[{"description":"Target node UUID or keyword self","required":true,"type":"string","name":"target-node-id","in":"path"},{"description":"URI of API to invoke on target node","required":true,"type":"string","name":"target-uri","in":"path"}],"tags":["System Administration","Configuration","NSX Managers","Clusters","Cluster Configuration"],"summary":"Invoke PUT request on target cluster node","x-vmw-nsx-module":"CentralApiModule","consumes":["application/json"],"operationId":"InvokePutClusterCentralAPI"},"post":{"responses":{"201":{"description":"Created"},"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"504":{"description":"Gateway Timeout"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Invoke POST request on target cluster node","parameters":[{"description":"Target node UUID or keyword self","required":true,"type":"string","name":"target-node-id","in":"path"},{"description":"URI of API to invoke on target node","required":true,"type":"string","name":"target-uri","in":"path"}],"tags":["System Administration","Configuration","NSX Managers","Clusters","Cluster Configuration"],"summary":"Invoke POST request on target cluster node","x-vmw-nsx-module":"CentralApiModule","consumes":["application/json"],"operationId":"InvokePostClusterCentralAPI"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"504":{"description":"Gateway Timeout"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Invoke DELETE request on target cluster node","parameters":[{"description":"Target node UUID or keyword self","required":true,"type":"string","name":"target-node-id","in":"path"},{"description":"URI of API to invoke on target node","required":true,"type":"string","name":"target-uri","in":"path"}],"tags":["System Administration","Configuration","NSX Managers","Clusters","Cluster Configuration"],"summary":"Invoke DELETE request on target cluster node","x-vmw-nsx-module":"CentralApiModule","consumes":["application/json"],"operationId":"InvokeDeleteClusterCentralAPI"},"get":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"504":{"description":"Gateway Timeout"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Invoke GET request on target cluster node","parameters":[{"description":"Target node UUID or keyword self","required":true,"type":"string","name":"target-node-id","in":"path"},{"description":"URI of API to invoke on target node","required":true,"type":"string","name":"target-uri","in":"path"}],"tags":["System Administration","Configuration","NSX Managers","Clusters","Cluster Configuration"],"summary":"Invoke GET request on target cluster node","x-vmw-nsx-module":"CentralApiModule","consumes":["application/json"],"operationId":"InvokeGetClusterCentralAPI"}},"/fabric/compute-managers/{compute-manager-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ComputeManager"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Updates a specified compute manager\n","parameters":[{"required":true,"type":"string","name":"compute-manager-id","in":"path"},{"schema":{"$ref":"#/definitions/ComputeManager"},"required":true,"name":"ComputeManager","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Compute Managers"],"summary":"Update compute manager","x-vmw-nsx-module":"InventoryCmObj","consumes":["application/json"],"operationId":"UpdateComputeManager"},"delete":{"responses":{"200":{"description":"OK"},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Unregisters a specified compute manager\n","parameters":[{"required":true,"type":"string","name":"compute-manager-id","in":"path"}],"tags":["System Administration","Configuration","Fabric","Compute Managers"],"summary":"Unregister a compute manager","x-vmw-nsx-module":"InventoryCmObj","consumes":["application/json"],"operationId":"DeleteComputeManager"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ComputeManager"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about a specific compute manager","parameters":[{"required":true,"type":"string","name":"compute-manager-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Compute Managers"],"summary":"Return compute manager Information","x-vmw-nsx-module":"InventoryCmObj","consumes":["application/json"],"operationId":"ReadComputeManager"}},"/logical-router-ports/{logical-router-port-id}/arp-table":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LogicalRouterPortArpTable"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns ARP table (IPv4) or Neighbor Discovery table (IPv6) for the\nLogical Router Port of the given id, on a node if a query parameter\n\"transport_node_id=<transport-node-id>\" is given. The transport_node_id\nparameter is mandatory if the router port is not uplink type.\nQuery parameter \"source=realtime\" is the only supported source.\n","parameters":[{"required":true,"type":"string","name":"logical-router-port-id","in":"path"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"},{"description":"TransportNode Id","required":false,"type":"string","name":"transport_node_id","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Logical Router Ports"],"summary":"Get the ARP table (IPv4) or Neighbor Discovery table (IPv6) for the\nLogical Router Port of the given id\n","x-vmw-nsx-module":"AggSvcLogicalRouterPort","consumes":["application/json"],"operationId":"GetLogicalRouterPortArpTable"}},"/repository/bundles?action=upload":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BundleId"}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Upload the bundle. This call returns after upload is completed.\nYou can check bundle processing status periodically by retrieving\nbundle upload-status to find out if the upload and processing is completed.\n","parameters":[{"description":"Local bundle","required":true,"type":"file","name":"file","in":"formData"},{"enum":["OVA"],"description":"Type of file","required":true,"in":"query","type":"string","name":"file_type"},{"enum":["SAMPLE","ALB_CONTROLLER","INTELLIGENCE"],"description":"Name of the appliance","required":true,"in":"query","type":"string","name":"product"}],"produces":["application/json"],"tags":["System Administration","Configuration","NSX Intelligence","Repository","Bundles"],"summary":"Upload bundle","x-vmw-nsx-module":"FileUploadFramework","consumes":["multipart/form-data"],"operationId":"UploadBundleViaLocalFile"}},"/node/aaa/providers/vidm":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeAuthProviderVidmProperties"}},"202":{"description":"Accepted","schema":{"$ref":"#/definitions/NodeAuthProviderVidmProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update AAA provider vIDM properties","parameters":[{"schema":{"$ref":"#/definitions/NodeAuthProviderVidmProperties"},"required":true,"name":"NodeAuthProviderVidmProperties","in":"body"}],"produces":["application/json"],"tags":["System Administration","Settings","User Management","VIDM Configuration"],"summary":"Update AAA provider vIDM properties","x-vmw-nsx-module":"NodeAuthProviderVidm","consumes":["application/json"],"operationId":"UpdateAuthProviderVidm"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeAuthProviderVidmProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read AAA provider vIDM properties","produces":["application/json"],"tags":["System Administration","Settings","User Management","VIDM Configuration"],"summary":"Read AAA provider vIDM properties","x-vmw-nsx-module":"NodeAuthProviderVidm","consumes":["application/json"],"operationId":"ReadAuthProviderVidm"}},"/upgrade/pre-upgrade-checks/failures":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UpgradeCheckFailureListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"description":"Internal Server Error"}},"description":"Get failures resulting from the last execution of pre-upgrade checks. If\nthe execution of checks is in progress, the response has the list of\nfailures observed so far.\n","parameters":[{"description":"Component type","required":false,"type":"string","name":"component_type","in":"query"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Filter text","required":false,"type":"string","name":"filter_text","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"enum":["COMPONENT","UPGRADE_UNIT"],"description":"Type of origin of failure","required":false,"in":"query","type":"string","name":"origin_type"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"enum":["FAILURE","WARNING"],"description":"Status of the upgrade check","required":false,"in":"query","type":"string","name":"type"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Upgrade","Plan"],"summary":"Get Pre-upgrade Check Failures","x-vmw-nsx-module":"Upgrade","consumes":["application/json"],"operationId":"GetPreUpgradeCheckFailures"}},"/cluster?action=join_cluster":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ClusterConfiguration"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"description":"Service Unavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Join this node to a NSX Cluster","parameters":[{"schema":{"$ref":"#/definitions/JoinClusterParameters"},"required":true,"name":"JoinClusterParameters","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","NSX Managers","Clusters","Cluster Configuration"],"summary":"Join this node to a NSX Cluster","x-vmw-nsx-module":"ClusterModule","consumes":["application/json"],"operationId":"JoinClusterJoinCluster"}},"/edge-clusters/{edge-cluster-id}/allocation-status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EdgeClusterAllocationStatus"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the allocation details of cluster and its members. Lists the edge\nnode members, active and standby services of each node, utilization details\nof configured sub-pools. These allocation details can be monitored by\ncustomers to trigger migration of certain service contexts to different\nedge nodes, to balance the utilization of edge node resources.\n","parameters":[{"required":true,"type":"string","name":"edge-cluster-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Edge Clusters","Edge Clusters"],"summary":"Get the Allocation details of an edge cluster","x-vmw-nsx-module":"EdgeClusters","consumes":["application/json"],"operationId":"GetEdgeClusterAllocationStatus"}},"/systemhealth/container-cluster/ncp/status":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/ContainerClusterStatus"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Create container cluster status list","parameters":[{"schema":{"$ref":"#/definitions/ContainerClusterStatus"},"required":true,"name":"ContainerClusterStatus","in":"body"}],"produces":["application/json"],"tags":["System Administration","Monitoring","System Health","Container"],"summary":"Create container cluster status list","x-vmw-nsx-module":"TnContainerStatus","consumes":["application/json"],"operationId":"CreateContainerClusterStatus"},"get":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/ContainerClusterStatusList"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get all the container cluster status","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"description":"Container status type","enum":["UNKNOWN","HEALTHY","DOWN","DEGRADED"],"type":"string","name":"status","in":"query"}],"produces":["application/json"],"tags":["System Administration","Monitoring","System Health","Container"],"summary":"Get all the container cluster status","x-vmw-nsx-module":"TnContainerStatus","consumes":["application/json"],"operationId":"ReadContainerClusterStatusList"}},"/ns-groups/unassociated-virtual-machines":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UnassociatedVMListResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get the list of all the virtual machines that are not a part of any existing NSGroup.\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Display Name of the virtual machine","required":false,"type":"string","name":"display_name","in":"query"},{"description":"VM types to be excluded","required":false,"type":"string","name":"exclude_vm_type","in":"query"},{"description":"External id of the virtual machine","required":false,"type":"string","name":"external_id","in":"query"},{"description":"Id of the host where this vif is located","required":false,"type":"string","name":"host_id","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Grouping Objects","NS Groups"],"summary":"Get the list of all the virtual machines that are not a part of any existing NSGroup.","x-vmw-nsx-module":"GroupingObjectsProviders","consumes":["application/json"],"operationId":"GetUnassociatedVirtualMachines"}},"/failure-domains":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/FailureDomain"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Creates a new failure domain.\n","parameters":[{"schema":{"$ref":"#/definitions/FailureDomain"},"required":true,"name":"FailureDomain","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Edge Clusters","Failure Domains"],"summary":"Create Failure Domain","x-vmw-nsx-module":"FailureDomain","consumes":["application/json"],"operationId":"CreateFailureDomain"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FailureDomainListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about configured failure domains.","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Edge Clusters","Failure Domains"],"summary":"List Failure Domains","x-vmw-nsx-module":"FailureDomain","consumes":["application/json"],"operationId":"ListFailureDomains"}},"/logical-routers/{logical-router-id}/routing":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RoutingConfig"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Modifies the routing configuration for a specified logical router.\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"schema":{"$ref":"#/definitions/RoutingConfig"},"required":true,"name":"RoutingConfig","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Routing Configuration"],"summary":"Update the Routing Configuration","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"UpdateRoutingConfig"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RoutingConfig"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the routing configuration for a specified logical router.\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Routing Configuration"],"summary":"Read the Routing Configuration","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"ReadRoutingConfig"}},"/configs/management":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ManagementConfig"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Modifies the NSX Management nodes global configuration.","parameters":[{"schema":{"$ref":"#/definitions/ManagementConfig"},"required":true,"name":"ManagementConfig","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","NSX Managers","Manager Configuration"],"summary":"Update NSX Management nodes global configuration","x-vmw-nsx-module":"ConfigManagement","consumes":["application/json"],"operationId":"UpdateManagementConfig"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ManagementConfig"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the NSX Management nodes global configuration.\n","produces":["application/json"],"tags":["System Administration","Configuration","NSX Managers","Manager Configuration"],"summary":"Read NSX Management nodes global configuration.","x-vmw-nsx-module":"ConfigManagement","consumes":["application/json"],"operationId":"ReadManagementConfig"}},"/loadbalancer/monitors":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/LbMonitor"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Create a load balancer monitor.\n","parameters":[{"schema":{"$ref":"#/definitions/LbMonitor"},"required":true,"name":"LbMonitor","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Create a load balancer monitor","x-vmw-nsx-module":"LoadBalancer","consumes":["application/json"],"operationId":"CreateLoadBalancerMonitor"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LbMonitorListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Retrieve a paginated list of load balancer monitors.\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"enum":["LbHttpMonitor","LbHttpsMonitor","LbIcmpMonitor","LbTcpMonitor","LbUdpMonitor","LbPassiveMonitor","LbActiveMonitor"],"description":"monitor query type","required":false,"in":"query","type":"string","name":"type"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Retrieve a paginated list of load balancer monitors","x-vmw-nsx-module":"LoadBalancer","consumes":["application/json"],"operationId":"ListLoadBalancerMonitors"}},"/serviceinsertion/services/{service-id}/service-deployments/{service-deployment-id}/state":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ConfigurationState"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns configuration state of deployed partner service using service insertion framework.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"required":true,"type":"string","name":"service-deployment-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Get Service-Deployment state for Service.","x-vmw-nsx-module":"ServiceInsertionVMDeployment","consumes":["application/json"],"operationId":"GetServiceDeploymentState"}},"/vpn/ipsec/ike-profiles":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/IPSecVPNIKEProfile"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Create custom internet key exchange (IKE) Profile. IKE Profile is a reusable profile that captures IKE and phase one negotiation parameters. System will be pre provisioned with system owned non editable default IKE profile and suggested set of profiles that can be used for peering with popular remote peers like AWS VPN. User can create custom profiles as needed. Any change in profile affects all sessions consuming this profile.","parameters":[{"schema":{"$ref":"#/definitions/IPSecVPNIKEProfile"},"required":true,"name":"IPSecVPNIKEProfile","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","VPN","IPSEC","IKE Profiles"],"summary":"Create custom internet key exchange (IKE) Profile","x-vmw-nsx-module":"IPSecVPN","consumes":["application/json"],"operationId":"CreateIPSecVPNIKEProfile"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IPSecVPNIKEProfileListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get paginated list of all IKE Profiles.","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","VPN","IPSEC","IKE Profiles"],"summary":"List IKE profiles","x-vmw-nsx-module":"IPSecVPN","consumes":["application/json"],"operationId":"ListIPSecVPNIKEProfiles"}},"/mac-sets":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/MACSet"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Creates a new MACSet that can group individual MAC addresses.\n","parameters":[{"schema":{"$ref":"#/definitions/MACSet"},"required":true,"name":"MACSet","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Grouping Objects","IP Sets"],"summary":"Create MACSet","x-vmw-nsx-module":"MACSet","consumes":["application/json"],"operationId":"CreateMACSet"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MACSetListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns paginated list of MACSets\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Grouping Objects","MAC Sets"],"summary":"List MACSets","x-vmw-nsx-module":"MACSet","consumes":["application/json"],"operationId":"ListMACSets"}},"/node/services":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServicePropertiesListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns a list of all services available on the node applicance.\n","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services"],"summary":"List node services","x-vmw-nsx-module":"NodeServices","consumes":["application/json"],"operationId":"ListNodeServices"}},"/global-configs/{config-type}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/GlobalConfigs"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Updates global configurations that belong to a config type. The request must\ninclude the updated values along with the unmodified values. The values that\nare updated(different) would trigger update to config-type specific state.\nHowever, the realization of the new configurations is config-type specific.\nRefer to config-type specific documentation for details about the config-\nuration push state.\nThis rest routine is deprecated, and will be removed after a year.\n","parameters":[{"required":true,"type":"string","name":"config-type","in":"path"},{"schema":{"$ref":"#/definitions/GlobalConfigs"},"required":true,"name":"GlobalConfigs","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Global Configurations"],"summary":"Update global configurations of a config type","x-vmw-nsx-module":"GlobalConfigs","consumes":["application/json"],"operationId":"UpdateGlobalConfigs"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/GlobalConfigs"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns global configurations that belong to the config type.\nThis rest routine is deprecated, and will be removed after a year.\n","parameters":[{"required":true,"type":"string","name":"config-type","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","Global Configurations"],"summary":"Get global configs for a config type","x-vmw-nsx-module":"GlobalConfigs","consumes":["application/json"],"operationId":"GetGlobalConfigs"}},"/serviceinsertion/source-entities":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SourceEntityResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Service insertion data path inserts unique 'source node id' value\ninto each packet. This API can be used to identify the source of the packet\nusing this value. It can be resolved to multiple source entities.\n","parameters":[{"description":"value","required":true,"type":"string","name":"source_node_value","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Resolve 'source node id' value to source entities.","x-vmw-nsx-module":"ServiceInsertion","consumes":["application/json"],"operationId":"ResolveSourceEntities"}},"/transport-nodes/{transport-node-id}?action=disable_flow_cache":{"post":{"responses":{"200":{"description":"OK"},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Disable flow cache for edge transport node.\nCaution: This involves restart of the edge\ndataplane and hence may lead to network disruption.\n","parameters":[{"required":true,"type":"string","name":"transport-node-id","in":"path"}],"tags":["System Administration","Configuration","Fabric","Nodes","Transport Nodes"],"summary":"Disable flow cache for an edge transport node","x-vmw-nsx-module":"TransportNodeLcm","consumes":["application/json"],"operationId":"DisableFlowCache"}},"/systemhealth/appliances/{appliance-id}/process/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ApplianceProcessData"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Show the details of process status in given appliance.\nThe appliance id can be obtained by below APIs.\n 1. /api/v1/cluster/nodes\n 2. /api/v1/systemhealth/appliances/process/status\n","parameters":[{"required":true,"type":"string","name":"appliance-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Monitoring","System Health","Appliance","Process"],"summary":"Show the details of process status in given appliance","x-vmw-nsx-module":"ShaApplianceMonitor","consumes":["application/json"],"operationId":"ShowApplianceProcessData"}},"/fabric/container-network-policies/{network-policy-id}":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ContainerNetworkPolicy"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about a specific network policy.","parameters":[{"required":true,"type":"string","name":"network-policy-id","in":"path"}],"produces":["application/json"],"tags":["Policy","Inventory","Containers","Container Clusters"],"summary":"Return a network policy spec","x-vmw-nsx-module":"InventoryContainerObj","consumes":["application/json"],"operationId":"GetContainerNetworkPolicy"}},"/node/central-config":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/CentralConfigProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update Central Config properties","parameters":[{"schema":{"$ref":"#/definitions/CentralConfigProperties"},"required":true,"name":"CentralConfigProperties","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Nodes","Manager Configuration"],"summary":"Update Central Config properties","x-vmw-nsx-module":"CentralConfig","consumes":["application/json"],"operationId":"UpdateCentralConfigProperties"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/CentralConfigProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read Central Config properties","produces":["application/json"],"tags":["System Administration","Configuration","Nodes","Manager Configuration"],"summary":"Read Central Config properties","x-vmw-nsx-module":"CentralConfig","consumes":["application/json"],"operationId":"ReadCentralConfigProperties"}},"/node?action=shutdown":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restarts or shuts down the NSX appliance.","tags":["System Administration","Configuration","Fabric","Nodes","Settings"],"summary":"Restart or shutdown node","x-vmw-nsx-module":"Node","consumes":["application/json"],"operationId":"RestartOrShutdownNodeShutdown"}},"/logical-routers/{logical-router-id}/routing/advertisement":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AdvertisementConfig"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Modifies the route advertisement configuration on the specified logical router.\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"schema":{"$ref":"#/definitions/AdvertisementConfig"},"required":true,"name":"AdvertisementConfig","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Routing Configuration"],"summary":"Update the Advertisement Configuration on a Logical Router","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"UpdateAdvertisementConfig"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AdvertisementConfig"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about the routes to be advertised by the specified\nTIER1 logical router.\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Routing Configuration"],"summary":"Read the Advertisement Configuration on a Logical Router","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"ReadAdvertisementConfig"}},"/migration/feedback-requests":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MigrationFeedbackRequestListResult"}},"401":{"description":"Unauthorized"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get feedback details of NSX-V to be migrated.\n","parameters":[{"description":"Category on which feedback request should be filtered","required":false,"type":"string","name":"category","in":"query"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Id of the site in NSX-T Federation","required":false,"type":"string","name":"federation_site_id","in":"query"},{"description":"Hash based on which feedback request should be filtered","required":false,"type":"string","name":"hash","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"enum":["L2","L3_L7"],"description":"Network layer for which feedback is generated","required":false,"in":"query","type":"string","name":"network_layer"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"enum":["ALL","RESOLVED","UNRESOLVED"],"description":"Filter based on current state of the feedback request","default":"ALL","required":false,"in":"query","type":"string","name":"state"},{"description":"Sub category based on which feedback request should be filtered","required":false,"type":"string","name":"sub_category","in":"query"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Migration","Feedback"],"summary":"NSX-V feedback details","x-vmw-nsx-module":"Migration","consumes":["application/json"],"operationId":"GetFeedbackRequests"}},"/upgrade/nodes":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeInfoListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get list of nodes. If request parameter component type is specified, then\nall nodes for that component will be returned. If request parameter component\nversion is specified, then all nodes at that version will be returned.\n","parameters":[{"description":"Component type based on which nodes will be filtered","required":false,"type":"string","name":"component_type","in":"query"},{"description":"Component version based on which nodes will be filtered","required":false,"type":"string","name":"component_version","in":"query"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Upgrade","Nodes"],"summary":"Get list of nodes across all types","x-vmw-nsx-module":"Upgrade","consumes":["application/json"],"operationId":"GetNodes"}},"/trust-management/certificates?action=set_pi_certificate_for_federation":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Set a certificate that has been imported to be either the principal\nidentity certificate for the local cluster with either GM or LM service\ntype.\nCurrently, the service type specified must match the current service type\nof the local cluster.\n","parameters":[{"schema":{"$ref":"#/definitions/SetPrincipalIdentityCertificateForFederationRequest"},"required":true,"name":"SetPrincipalIdentityCertificateForFederationRequest","in":"body"}],"summary":"Set a certificate as a GM or LM Principal Identity certificate","x-vmw-nsx-module":"CertificateManager","consumes":["application/json"],"operationId":"SetPrincipalIdentityCertificateForFederation"}},"/serviceinsertion/sections":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/ServiceInsertionSection"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Creates new empty Service Insertion section in the system.\nNote- POST service insertion section API is deprecated. Please use the\npolicy redirection-policy API.\n","parameters":[{"schema":{"$ref":"#/definitions/ServiceInsertionSection"},"required":true,"name":"ServiceInsertionSection","in":"body"},{"in":"query","description":"Identifier of the anchor rule or section. This is a required field in case operation like 'insert_before' and 'insert_after'.","required":false,"maxLength":64,"type":"string","name":"id"},{"enum":["insert_top","insert_bottom","insert_after","insert_before"],"description":"Operation","default":"insert_top","required":false,"in":"query","type":"string","name":"operation"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Create a New Empty Section","x-vmw-nsx-module":"ServiceInsertionRules","consumes":["application/json"],"operationId":"AddServiceInsertionSection"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ServiceInsertionSectionListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"List all Service Insertion section in paginated form. A default page size is limited\nto 1000 sections. By default, the list of section is filtered by L3REDIRECT\ntype.\nNote- GET service insertion sections API is deprecated. Please use the\npolicy redirection-policy API.\n","parameters":[{"description":"AppliedTo's referenced by this section or section's Distributed Service Rules .","required":false,"type":"string","name":"applied_tos","in":"query"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Destinations referenced by this section's Distributed Service Rules .","required":false,"type":"string","name":"destinations","in":"query"},{"enum":["NSGroup","LogicalSwitch","LogicalRouter","LogicalPort"],"description":"Resource type valid for use as AppliedTo filter in section API","required":false,"in":"query","type":"string","name":"exclude_applied_to_type"},{"enum":["FILTER","SEARCH"],"description":"Filter type","default":"FILTER","required":false,"in":"query","type":"string","name":"filter_type"},{"enum":["NSGroup","LogicalSwitch","LogicalRouter","LogicalPort"],"description":"Resource type valid for use as AppliedTo filter in section API","required":false,"in":"query","type":"string","name":"include_applied_to_type"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"description":"NSService referenced by this section's Distributed Service Rules .","required":false,"type":"string","name":"services","in":"query"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"description":"Sources referenced by this section's Distributed Service Rules .","required":false,"type":"string","name":"sources","in":"query"},{"enum":["L3REDIRECT"],"description":"Section Type","default":"L3REDIRECT","required":false,"in":"query","type":"string","name":"type"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"List All Service Insertion Sections","x-vmw-nsx-module":"ServiceInsertionRules","consumes":["application/json"],"operationId":"ListServiceInsertionSections"}},"/node/services/cluster_manager?action=restart":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the cluster boot manager service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Cluster Manager Service"],"summary":"Restart, start or stop the cluster boot manager service","x-vmw-nsx-module":"NodeClusterBootManagerService","consumes":["application/json"],"operationId":"CreateClusterBootManagerServiceActionRestart"}},"/fabric/container-application-instances":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ContainerApplicationInstanceListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about all container application instance.","parameters":[{"description":"Identifier of the container application","required":false,"type":"string","name":"container_application_id","in":"query"},{"description":"Identifier of the container cluster","required":false,"type":"string","name":"container_cluster_id","in":"query"},{"description":"Identifier of the container project","required":false,"type":"string","name":"container_project_id","in":"query"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"description":"Scope id for container cluster","required":false,"type":"string","name":"scope_id","in":"query"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Policy","Inventory","Containers","Container Applications"],"summary":"Return the list of container application instance","x-vmw-nsx-module":"InventoryContainerObj","consumes":["application/json"],"operationId":"ListContainerApplicationInstances"}},"/fabric/container-cluster-nodes":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ContainerClusterNodeListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about all container cluster nodes.","parameters":[{"description":"Identifier of the container cluster","required":false,"type":"string","name":"container_cluster_id","in":"query"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"description":"Scope id for container cluster","required":false,"type":"string","name":"scope_id","in":"query"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Policy","Inventory","Containers","Container Clusters"],"summary":"Return the list of container cluster nodes","x-vmw-nsx-module":"InventoryContainerObj","consumes":["application/json"],"operationId":"ListContainerClusterNodes"}},"/node/aaa/providers/vidm/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeAuthProviderVidmStatus"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read AAA provider vIDM status","produces":["application/json"],"tags":["System Administration","Settings","User Management","VIDM Configuration"],"summary":"Read AAA provider vIDM status","x-vmw-nsx-module":"NodeAuthProviderVidm","consumes":["application/json"],"operationId":"ReadAuthProviderVidmStatus"}},"/firewall/sections/{section-id}?action=list_with_rules":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FirewallSectionRuleList"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns firewall section information with rules for a section identifier.\nWhen invoked on a section with a large number of rules, this API is supported\nonly at low rates of invocation (not more than 4-5 times per minute). The\ntypical latency of this API with about 1024 rules is about 4-5 seconds. This\nAPI should not be invoked with large payloads at automation speeds. More than\n50 rules with a large number rule references is not supported.\n\nInstead, to read firewall rules, use:\nGET /api/v1/firewall/sections/<section-id>/rules with the appropriate\npage_size.\n","parameters":[{"required":true,"type":"string","name":"section-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Firewall"],"summary":"Get an Existing Section, Including Rules","x-vmw-nsx-module":"Firewall","consumes":["application/json"],"operationId":"GetSectionWithRules"}},"/serviceinsertion/services":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/ServiceDefinition"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Creates new Service-Insertion Service in the system.\n","parameters":[{"schema":{"$ref":"#/definitions/ServiceDefinition"},"required":true,"name":"ServiceDefinition","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Create a Service-Insertion Service","x-vmw-nsx-module":"ServiceInsertion","consumes":["application/json"],"operationId":"AddServiceInsertionService"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ServiceInsertionServiceListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"List all Service-Insertion Service Definitions.\n","produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"List all Service-Insertion Services.","x-vmw-nsx-module":"ServiceInsertion","consumes":["application/json"],"operationId":"ListServiceInsertionServices"}},"/transport-nodes/{node-id}/modules":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SoftwareModuleResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get the module details of a transport node\nThis api is now deprecated. Please use new api -\n/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/host-transport-nodes/<host-transport-node-id>/modules\n","parameters":[{"required":true,"type":"string","name":"node-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Transport Nodes"],"summary":"Get the module details of a transport node\nThis api is now deprecated. Please use new api -\n/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/host-transport-nodes/<host-transport-node-id>/modules\n","x-vmw-nsx-module":"TransportNodeLcm","consumes":["application/json"],"operationId":"GetFabricNodeModulesOfTransportNode"}},"/logical-routers/{logical-router-id}/routing/bgp/neighbors/{neighbor-id}/advertised-routes":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BgpNeighborRouteDetails"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns routes advertised by BGP neighbor from all edge transport nodes on which\nthis neighbor is currently enabled. It always returns realtime response.\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"required":true,"type":"string","name":"neighbor-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Logical Routers"],"summary":"Get BGP neighbor advertised routes","x-vmw-nsx-module":"AggSvcLogicalRouter","consumes":["application/json"],"operationId":"GetBgpNeighborAdvertisedRoutes"}},"/node/services/http?action=apply_certificate":{"post":{"responses":{"200":{"description":"OK"},"202":{"description":"Accepted"},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Applies a security certificate to the http service. In the POST request,\nthe CERTIFICATE_ID references a certificate created with the\n/api/v1/trust-management APIs. If the certificate used is a CA signed\ncertificate,the request fails if the whole chain(leaf, intermediate, root)\nis not imported.\n","parameters":[{"description":"Certificate ID","required":true,"type":"string","name":"certificate_id","in":"query"}],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","HTTP Service"],"summary":"Update http service certificate","x-vmw-nsx-module":"NodeProxyService","consumes":["application/json"],"operationId":"CreateProxyServiceApplyCertificateActionApplyCertificate"}},"/serviceinsertion/services/{service-id}/service-instances/{service-instance-id}/instance-runtimes/{instance-runtime-id}/interfaces/{interface_index}/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RuntimeInterfaceOperationalStatus"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns operational status of a specified interface","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"required":true,"type":"string","name":"service-instance-id","in":"path"},{"required":true,"type":"string","name":"instance-runtime-id","in":"path"},{"required":true,"type":"string","name":"interface_index","in":"path"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Get operational status for an interface","x-vmw-nsx-module":"ServiceInsertionVMDeployment","consumes":["application/json"],"operationId":"GetRuntimeInterfaceOperationalStatus"}},"/node/services/applianceproxy?action=restart":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the Appliance Proxy Service","produces":["application/json"],"tags":["Management Plane API","NSX Component Administration","Appliance Management"],"summary":"Restart, start or stop the Appliance Proxy Service","x-vmw-nsx-module":"NodeApplProxy","consumes":["application/json"],"operationId":"CreateApplProxyActionRestart"}},"/migration/vmgroup?action=pre_migrate":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"For each VM group, the following three high level steps are performed in sequence.\n1. Call pre VM group migrate API.\n2. Migrate (by vmotion,in place, etc.,) VMs in the VM group. This step will be done by user independent of MC.\n3. Call post VM group migrate API with the same VM group id used in the pre VM group migrate API.\nThis API specifically deals with pre VM group migrate API. When pre VM group migrate API is invoked for a VM group\nid, MC performs following actions.\n - Checks segmentation realization state.\n - Creates segment ports.\n - Creates temporary security groups.\n","parameters":[{"schema":{"$ref":"#/definitions/PreVmGroupMigrationSpec"},"required":true,"name":"PreVmGroupMigrationSpec","in":"body"}],"tags":["System Administration","Lifecycle Management","Migration","Vmgroup"],"summary":"Perform steps required before migrating a VM group.","x-vmw-nsx-module":"Migration","consumes":["application/json"],"operationId":"PreVmGroupMigrate"}},"/ns-groups/{ns-group-id}/effective-ip-address-members":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EffectiveIPAddressMemberListResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns effective ip address members of the specified NSGroup.\nThis API is applicable only for NSGroups containing either\nVirtualMachine, VIF, LogicalSwitch, LogicalPort or IPSet member type.\nFor NSGroups containing other member types,it returns an empty list.\n","parameters":[{"description":"NSGroup Id","required":true,"type":"string","name":"ns-group-id","in":"path"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Grouping Objects","NS Groups"],"summary":"Get Effective IPAddress translated from the NSGroup","x-vmw-nsx-module":"NSGroup","consumes":["application/json"],"operationId":"GetEffectiveIPAddressMembers"}},"/alarms/{alarm-id}?action=set_status":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Alarm"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update status of an Alarm. The new_status value can be OPEN, ACKNOWLEDGED, SUPPRESSED, or RESOLVED. If new_status is SUPPRESSED, the suppress_duration query parameter must also be specified.","parameters":[{"required":true,"type":"string","name":"alarm-id","in":"path"},{"enum":["OPEN","ACKNOWLEDGED","SUPPRESSED","RESOLVED"],"description":"Status","required":true,"in":"query","type":"string","name":"new_status"},{"description":"Duration in hours for which Alarm should be suppressed","format":"int64","type":"integer","name":"suppress_duration","in":"query"}],"produces":["application/json"],"tags":["System Administration","Monitoring","Alarms And Events"],"summary":"Update staus of alarm identified by alarm-id.","x-vmw-nsx-module":"Monitoring","consumes":["application/json"],"operationId":"UpdateAlarmStatus"}},"/vpn/ipsec/sessions/{ipsec-vpn-session-id}/peer-config":{"get":{"responses":{"200":{"description":"OK","schema":{"type":"string"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"API to download VPN configuration for the peer site. The configuration contains pre-shared key and secret; be careful when sharing or storing it.","parameters":[{"required":true,"type":"string","name":"ipsec-vpn-session-id","in":"path"}],"produces":["text/plain; charset=utf-8"],"tags":["Management Plane API","Networking","VPN","IPSEC","Sessions"],"summary":"Get VPN configuration for the peer site","x-vmw-nsx-module":"IPSecVPN","consumes":["application/json"],"operationId":"GetPeerConfig"}},"/notification-watchers/{watcher-id}/notifications?action=add_uri_filters":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NotificationsList"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"description":"Bad Request"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Add uri filters for the specified watcher ID.","parameters":[{"required":true,"type":"string","name":"watcher-id","in":"path"},{"schema":{"$ref":"#/definitions/Notification"},"required":true,"name":"Notification","in":"body"}],"produces":["application/json"],"tags":["System Administration","Monitoring","Notifications"],"summary":"Add uri filters for the specified watcher ID.","x-vmw-nsx-module":"NfwConfig","consumes":["application/json"],"operationId":"AddUriFilters"}},"/logical-routers/{logical-router-id}/routing/bgp/neighbors/{id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BgpNeighbor"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update a specific BGP Neighbor on a Logical Router\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"required":true,"type":"string","name":"id","in":"path"},{"schema":{"$ref":"#/definitions/BgpNeighbor"},"required":true,"name":"BgpNeighbor","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Routing Configuration"],"summary":"Update a specific BGP Neighbor on a Logical Router","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"UpdateBgpNeighbor"},"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BgpNeighbor"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Unset/Delete the password property on the specific BGP Neighbor.\nNo other property of the BgpNeighbor can be updated using this API\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"required":true,"type":"string","name":"id","in":"path"},{"enum":["clear_password"],"type":"string","name":"action","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Routing Configuration"],"summary":"Unset/Delete password property on specific BGP Neighbor on Logical Router","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"UnSetPasswordOnBgpNeighbor"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BgpNeighbor"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read a specific BGP Neighbor on a Logical Router\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"required":true,"type":"string","name":"id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Routing Configuration"],"summary":"Read a specific BGP Neighbor on a Logical Router","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"ReadBgpNeighbor"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete a specific BGP Neighbor on a Logical Router\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"required":true,"type":"string","name":"id","in":"path"}],"tags":["Management Plane API","Networking","Logical Routing And Services","Routing Configuration"],"summary":"Delete a specific BGP Neighbor on a Logical Router","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"DeleteBgpNeighbor"}},"/node/services/node-stats?action=stop":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the NSX node-stats service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Node Stats Service"],"summary":"Restart, start or stop the NSX node-stats service","x-vmw-nsx-module":"NodeNodeStatsService","consumes":["application/json"],"operationId":"CreateNodeStatsServiceActionStop"}},"/node/services/ssh/notify_mpa?action=restart":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the ssh service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","SSH"],"summary":"Restart, start or stop the ssh service","x-vmw-nsx-module":"NodeSSHService","consumes":["application/json"],"operationId":"CreateSSHServiceActionNotifyMpaRestart"}},"/loadbalancer/services":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/LbService"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Create a load balancer service.\n","parameters":[{"schema":{"$ref":"#/definitions/LbService"},"required":true,"name":"LbService","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Create a load balancer service","x-vmw-nsx-module":"LoadBalancer","consumes":["application/json"],"operationId":"CreateLoadBalancerService"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LbServiceListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Retrieve a paginated list of load balancer services.\nWhen logical_router_id is specified in request parameters, the\nassociated load balancer services which are related to the given\nlogical router returned.\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Logical router identifier","type":"string","name":"logical_router_id","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Retrieve a paginated list of load balancer services","x-vmw-nsx-module":"LoadBalancer","consumes":["application/json"],"operationId":"ListLoadBalancerServices"}},"/node/users/{userid}/ssh-keys":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SshKeyPropertiesListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"description":"Internal Server Error"}},"description":"Returns a list of all SSH keys from authorized_keys file for node user\n","parameters":[{"description":"User id of the user","required":true,"type":"string","name":"userid","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","User Management","Users"],"summary":"List SSH keys from authorized_keys file for node user","x-vmw-nsx-module":"NodeUsers","consumes":["application/json"],"operationId":"ListNodeUserSshKeys"}},"/idfw/standalone-host-switch-setting":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IdfwStandaloneHostsSwitchSetting"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"description":"Bad Request"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update Identity Firewall standalone hosts switch setting\n(true=enabled / false=disabled).\n","parameters":[{"schema":{"$ref":"#/definitions/IdfwStandaloneHostsSwitchSetting"},"required":true,"name":"IdfwStandaloneHostsSwitchSetting","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Security","Identity Firewall","Configuration"],"summary":"Update IDFW master switch setting enabled/disabled","x-vmw-nsx-module":"IdentityFirewall","consumes":["application/json"],"operationId":"UpdateStandaloneHostsSwitchSetting"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IdfwStandaloneHostsSwitchSetting"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Fetches IDFW standalone hosts switch setting to check whether standalone\nhosts is enabled or disabled\n","produces":["application/json"],"tags":["Management Plane API","Security","Identity Firewall","Configuration"],"summary":"Get Standalone hosts switch enabled/disabled","x-vmw-nsx-module":"IdentityFirewall","consumes":["application/json"],"operationId":"GetStandaloneHostsSwitchSetting"}},"/serviceinsertion/sections/{section-id}/rules?action=create_multiple":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ServiceInsertionRuleList"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"description":"Bad Request"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Create multiple serviceinsertion rules in existing serviceinsertion section bounded by\nlimit of 1000 serviceinsertion rules per section.\nNote- POST service insertion rules API is deprecated.\nPlease use policy redirection-policy API.\n","parameters":[{"required":true,"type":"string","name":"section-id","in":"path"},{"schema":{"$ref":"#/definitions/ServiceInsertionRuleList"},"required":true,"name":"ServiceInsertionRuleList","in":"body"},{"in":"query","description":"Identifier of the anchor rule or section. This is a required field in case operation like 'insert_before' and 'insert_after'.","required":false,"maxLength":64,"type":"string","name":"id"},{"enum":["insert_top","insert_bottom","insert_after","insert_before"],"description":"Operation","default":"insert_top","required":false,"in":"query","type":"string","name":"operation"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Add Multiple Rules in a Section","x-vmw-nsx-module":"ServiceInsertionRules","consumes":["application/json"],"operationId":"AddServiceInsertionRulesInSection"}},"/intrusion-services/ids-summary":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IDSSummaryListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"description":"Bad Request"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get the summary of all the intrusions that are detected grouped by signature\nwith details including signature name, id, severity, attack type, protocol,\nfirst and recent occurence, and affected users and VMs.\n","parameters":[{"schema":{"$ref":"#/definitions/IDSEventDataRequest"},"required":true,"name":"IDSEventDataRequest","in":"body"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Security","Intrusion Services","Dashboard"],"summary":"Get the summary of the intrusions that were detected.","x-vmw-nsx-module":"IDSMetrics","consumes":["application/json"],"operationId":"GetIdsDashboardSummary"}},"/node/services/install-upgrade/uc-state":{"put":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"409":{"description":"Conflict"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update UC state properties","parameters":[{"schema":{"$ref":"#/definitions/UcStateProperties"},"required":true,"name":"UcStateProperties","in":"body"}],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Install Upgrade Service"],"summary":"Update UC state properties","x-vmw-nsx-module":"NodeInstallUpgradeService","consumes":["application/json"],"operationId":"UpdateUcState"}},"/ns-groups/{ns-group-id}/effective-logical-port-members":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EffectiveMemberResourceListResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns effective logical port members of the specified NSGroup.\nThis API is applicable only for NSGroups containing either VirtualMachines,\nLogicalSwitch or LogicalPort member types.For NSGroups containing other\nmember types,it returns an empty list.\n","parameters":[{"description":"NSGroup Id","required":true,"type":"string","name":"ns-group-id","in":"path"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Grouping Objects","NS Groups"],"summary":"Get Effective Logical Ports translated from the NSgroup","x-vmw-nsx-module":"NSGroup","consumes":["application/json"],"operationId":"GetEffectiveLogicalPortMembers"}},"/migration/discovered-switches":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MigrationSwitchListResult"}},"401":{"description":"Unauthorized"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get the list of discovered switches (DVS, VSS) for the selected VC.\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Migration","User Inputs"],"summary":"Get the list of discovered switches (DVS, VSS)","x-vmw-nsx-module":"Migration","consumes":["application/json"],"operationId":"GetDiscoveredSwitches"}},"/node/services/search?action=restart":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the NSX Search service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Search Service"],"summary":"Restart, start or stop the NSX Search service","x-vmw-nsx-module":"NodeSearchService","consumes":["application/json"],"operationId":"CreateSearchServiceActionRestart"}},"/trust-management/certificates":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/CertificateList"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns all certificate information viewable by the user, including each\ncertificate's UUID; resource_type (for example, certificate_self_signed,\ncertificate_ca, or certificate_signed); pem_encoded data; and history of the\ncertificate (who created or modified it and when). For additional\ninformation, include the ?details=true modifier at the end of the request\nURI.\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"whether to expand the pem data and show all its details","default":false,"required":false,"in":"query","type":"boolean","name":"details"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"enum":["cluster_api_certificate"],"description":"Type of certificate to return","required":false,"in":"query","type":"string","name":"type"}],"produces":["application/json"],"tags":["System Administration","Settings","Certificates","Certificate"],"summary":"Return All the User-Facing Components' Certificates","x-vmw-nsx-module":"CertificateManager","consumes":["application/json"],"operationId":"GetCertificates"}},"/dhcp/servers/{server-id}/ipv6-static-bindings/{binding-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DhcpV6StaticBinding"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update a specific static binding of a given local DHCP IPv6 server.","parameters":[{"required":true,"type":"string","name":"server-id","in":"path"},{"required":true,"type":"string","name":"binding-id","in":"path"},{"schema":{"$ref":"#/definitions/DhcpV6StaticBinding"},"required":true,"name":"DhcpV6StaticBinding","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","DHCP"],"summary":"Update a DHCP IPv6 server's static binding","x-vmw-nsx-module":"Dhcp","consumes":["application/json"],"operationId":"UpdateDhcpV6StaticBinding"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DhcpV6StaticBinding"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Return a specific static binding of a given logical DHCP IPv6 server.\n","parameters":[{"required":true,"type":"string","name":"server-id","in":"path"},{"required":true,"type":"string","name":"binding-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","DHCP"],"summary":"Get a DHCP IPv6 server's static binding with the specified binding ID","x-vmw-nsx-module":"Dhcp","consumes":["application/json"],"operationId":"ReadDhcpV6StaticBinding"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete a specific static binding of a given logical DHCP IPv6 server.","parameters":[{"required":true,"type":"string","name":"server-id","in":"path"},{"required":true,"type":"string","name":"binding-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","DHCP"],"summary":"Delete a static binding for DHCP IPv6 server","x-vmw-nsx-module":"Dhcp","consumes":["application/json"],"operationId":"DeleteDhcpV6StaticBinding"}},"/pktcap/sessions?action=delete":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PacketCaptureSessionList"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete all the packet capture sessions.\n","produces":["application/json"],"tags":["Management Plane API","Troubleshooting And Monitoring","Packet Capture"],"summary":"Delete all the packet capture sessions","x-vmw-nsx-module":"PacketCapture","consumes":["application/json"],"operationId":"DeleteAllCaptureSessions"}},"/aaa/roles":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RoleListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get information about all roles","produces":["application/json"],"tags":["System Administration","Settings","User Management","Roles"],"summary":"Get information about all roles","x-vmw-nsx-module":"AAA","consumes":["application/json"],"operationId":"GetAllRolesInfo"}},"/node/services/nsx-message-bus?action=stop":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the NSX Message Bus service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","NSX Message Service"],"summary":"Restart, start or stop the NSX Message Bus service","x-vmw-nsx-module":"NodeNSXMessageBusService","consumes":["application/json"],"operationId":"CreateNSXMessageBusServiceActionStop"}},"/transport-zones/{zone-id}/transport-node-status-report":{"get":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"You must provide the request header \"Accept:application/octet-stream\" when calling this API.","parameters":[{"description":"ID of transport zone","required":true,"type":"string","name":"zone-id","in":"path"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"},{"description":"Transport node","enum":["UP","DOWN","DEGRADED"],"type":"string","name":"status","in":"query"}],"produces":["application/octet-stream"],"tags":["System Administration","Configuration","Fabric","Nodes","Transport Node Status"],"summary":"Creates a status report of transport nodes in a transport zone","x-vmw-nsx-module":"Heatmap","consumes":["application/json"],"operationId":"GetTransportNodeReportForATransportZone"}},"/fabric/cloud-native-service-instances/{external-id}":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/CloudNativeServiceInstance"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about a particular cloud native service instance\nby external-id.\n","parameters":[{"required":true,"type":"string","name":"external-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Cloud Native Service Instances"],"summary":"Returns information about a particular cloud native service instance\nby external-id.\n","x-vmw-nsx-module":"InventoryCloudObj","consumes":["application/json"],"operationId":"GetCloudNativeServiceInstance"}},"/pktcap/session":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PacketCaptureSession"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Create an new packet capture session on given node with specified options\n","parameters":[{"schema":{"$ref":"#/definitions/PacketCaptureRequest"},"required":true,"name":"PacketCaptureRequest","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Troubleshooting And Monitoring","Packet Capture"],"summary":"Create an new packet capture session","x-vmw-nsx-module":"PacketCapture","consumes":["application/json"],"operationId":"CreatePacketCaptureSession"}},"/node/upgrade":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UpgradeTaskProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get upgrade task status for the given task of the given bundle.\nBoth bundle_name and task_id must be provided, otherwise you\nwill receive a 404 NOT FOUND response. This api is deprecated.\nPlease use API GET /node/upgrade/status-summary to get upgrade\nstatus when upgrade is in progress.\n","parameters":[{"pattern":"/^[a-zA-Z0-9-.]+$/","description":"Bundle Name","type":"string","name":"bundle_name","in":"query"},{"pattern":"/^[a-z0-9-]+$/","description":"Upgrade Task ID","type":"string","name":"upgrade_task_id","in":"query"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Upgrade","Nodes"],"summary":"Get upgrade task status","x-vmw-nsx-module":"UpgradeNodeActions","consumes":["application/json"],"operationId":"GetUpgradeTaskStatus"}},"/notification-watchers":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/NotificationWatcher"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"description":"Bad Request"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Add a new notification watcher.","parameters":[{"schema":{"$ref":"#/definitions/NotificationWatcher"},"required":true,"name":"NotificationWatcher","in":"body"}],"produces":["application/json"],"tags":["System Administration","Monitoring","Notifications"],"summary":"Add a new notification watcher.","x-vmw-nsx-module":"NfwConfig","consumes":["application/json"],"operationId":"AddNotificationWatcher"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NotificationWatcherListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns a list of registered notification watchers.","produces":["application/json"],"tags":["System Administration","Monitoring","Notifications"],"summary":"Returns a list of registered notification watchers.","x-vmw-nsx-module":"NfwConfig","consumes":["application/json"],"operationId":"ListNotificationWatchers"}},"/vpn/l2vpn/sessions/{session-id}/statistics":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/L2VPNSessionStatistics"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get statistics of a L2VPN session. Query parameter source=realtime is the only supported source.","parameters":[{"required":true,"type":"string","name":"session-id","in":"path"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"}],"produces":["application/json"],"tags":["Management Plane API","Networking","VPN","Statistics","L2VPN Session Statistics"],"summary":"Get L2VPN session statistics","x-vmw-nsx-module":"L2VPNStatistics","consumes":["application/json"],"operationId":"GetL2VPNSessionStatistics"}},"/logical-routers/{logical-router-id}/routing/bfd-config":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BfdConfig"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Modifies the BFD configuration for routing BFD peers. Note - the configuration |\n changes apply only to those routing BFD peers for which the BFD configuration has |\n not been overridden at Peer level.\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"schema":{"$ref":"#/definitions/BfdConfig"},"required":true,"name":"BfdConfig","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Routing BFD Configuration"],"summary":"Update the BFD Configuration for BFD peers for routing","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"UpdateRoutingBfdConfig"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BfdConfig"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the BFD configuration for all routing BFD peers. This will be inherited |\n by all BFD peers for LogicalRouter unless overriden while configuring the Peer.\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Routing BFD Configuration"],"summary":"Read the Routing BFD Configuration","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"ReadRoutingBfdConfig"}},"/logical-ports/{lport-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LogicalPort"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Modifies an existing logical switch port. Parameters that can be modified\ninclude attachment_type (LOGICALROUTER, VIF), admin_state (UP or DOWN),\nattachment id and switching_profile_ids. You cannot modify the logical_switch_id.\nIn other words, you cannot move an existing port from one switch to another switch.\nThis api is now deprecated. \nPlease use new api - /infra/segments/<segment-id>/ports/<port-id>\n","parameters":[{"required":true,"type":"string","name":"lport-id","in":"path"},{"schema":{"$ref":"#/definitions/LogicalPort"},"required":true,"name":"LogicalPort","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Switching","Logical Switch Ports"],"summary":"Update a Logical Port","x-vmw-nsx-module":"LogicalPort","consumes":["application/json"],"operationId":"UpdateLogicalPort"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LogicalPort"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about a specified logical port. in impactor-ufo branch. Please use corresponding policy API /infra/segments/<segment-id>/ports/<lport-id>","parameters":[{"required":true,"type":"string","name":"lport-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Switching","Logical Switch Ports"],"summary":"Get Information About a Logical Port","x-vmw-nsx-module":"LogicalPort","consumes":["application/json"],"operationId":"GetLogicalPort"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Deletes the specified logical switch port. By default, if logical port has\nattachments, or it is added to any NSGroup, the deletion will be failed.\nOption detach could be used for deleting logical port forcibly. This api is now deprecated.\nPlease use new api - DELETE /infra/segments/<segment-id>/ports/<port-id>\n","parameters":[{"required":true,"type":"string","name":"lport-id","in":"path"},{"description":"force delete even if attached or referenced by a group","default":false,"required":false,"in":"query","type":"boolean","name":"detach"}],"tags":["Management Plane API","Networking","Logical Switching","Logical Switch Ports"],"summary":"Delete a Logical Port","x-vmw-nsx-module":"LogicalPort","consumes":["application/json"],"operationId":"DeleteLogicalPort"}},"/node/services/snmp/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read SNMP service status","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","SNMP"],"summary":"Read SNMP service status","x-vmw-nsx-module":"NodeSNMPService","consumes":["application/json"],"operationId":"ReadSNMPServiceStatus"}},"/trust-management/principal-identities":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/PrincipalIdentity"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Associates a principal's name with a certificate that is used to authenticate.\nThe combination name and node_id needs to be unique across token-based and\ncertificate-based principal identities.\nDeprecated, use POST /trust-management/principal-identities/with-certificate instead.\n","parameters":[{"schema":{"$ref":"#/definitions/PrincipalIdentity"},"required":true,"name":"PrincipalIdentity","in":"body"}],"produces":["application/json"],"tags":["System Administration","Settings","User Management","Principal Identity"],"summary":"Register a name-certificate combination.","x-vmw-nsx-module":"CertificateManager","consumes":["application/json"],"operationId":"RegisterPrincipalIdentity"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PrincipalIdentityList"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the list of principals registered with a certificate.","produces":["application/json"],"tags":["System Administration","Settings","User Management","Principal Identity"],"summary":"Return the list of principal identities","x-vmw-nsx-module":"CertificateManager","consumes":["application/json"],"operationId":"GetPrincipalIdentities"}},"/firewall/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/FirewallStatusListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"List all firewall status for supported contexts","produces":["application/json"],"tags":["Management Plane API","Security","Services","Firewall"],"summary":"List all firewall status for supported contexts","x-vmw-nsx-module":"FirewallStatus","consumes":["application/json"],"operationId":"ListFirewallStatus"}},"/node/services/install-upgrade?action=restart":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"409":{"description":"Conflict"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the NSX install-upgrade service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Install Upgrade Service"],"summary":"Restart, start or stop the NSX install-upgrade service","x-vmw-nsx-module":"NodeInstallUpgradeService","consumes":["application/json"],"operationId":"CreateRepositoryServiceActionRestart"}},"/trust-management/certificates?action=import":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/CertificateList"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Adds a new private-public certificate or a chain of certificates (CAs) and,\noptionally, a private key that can be applied to one of the user-facing\ncomponents (appliance management or edge). The certificate and the key\nshould be stored in PEM format. If no private key is provided, the\ncertificate is used as a client certificate in the trust store.\nA private key can be uploaded for a CA certificate only if the \"purpose\"\nparameter is set to \"signing-ca\".\n","parameters":[{"schema":{"$ref":"#/definitions/TrustObjectData"},"required":true,"name":"TrustObjectData","in":"body"}],"produces":["application/json"],"tags":["System Administration","Settings","Certificates","Certificate"],"summary":"Add a New Certificate","x-vmw-nsx-module":"CertificateManager","consumes":["application/json"],"operationId":"AddCertificate"}},"/node/services/manager/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read service status","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Manager Service"],"summary":"Read service status","x-vmw-nsx-module":"NodeProtonService","consumes":["application/json"],"operationId":"ReadProtonServiceStatus"}},"/ns-groups/{ns-group-id}/effective-directory-group-members":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EffectiveMemberResourceListResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns effective directory groups which are members of the specified NSGroup.\nThis API is applicable only for NSGroups containing DirectoryGroup member type.\nFor NSGroups containing other member types,it returns an empty list.\n","parameters":[{"description":"NSGroup Id","required":true,"type":"string","name":"ns-group-id","in":"path"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Grouping Objects","NS Groups"],"summary":"Get Effective Directory Groups of the specified NSGroup.","x-vmw-nsx-module":"NSGroup","consumes":["application/json"],"operationId":"GetEffectiveActiveDirectoryGroups"}},"/loadbalancer/virtual-servers/{virtual-server-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LbVirtualServer"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update a load balancer virtual server.\n","parameters":[{"required":true,"type":"string","name":"virtual-server-id","in":"path"},{"schema":{"$ref":"#/definitions/LbVirtualServer"},"required":true,"name":"LbVirtualServer","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Update a load balancer virtual server","x-vmw-nsx-module":"LoadBalancer","consumes":["application/json"],"operationId":"UpdateLoadBalancerVirtualServer"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete a load balancer virtual server.\n","parameters":[{"required":true,"type":"string","name":"virtual-server-id","in":"path"},{"description":"Delete associated rules","default":false,"required":false,"in":"query","type":"boolean","name":"delete_associated_rules"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Delete a load balancer virtual server","x-vmw-nsx-module":"LoadBalancer","consumes":["application/json"],"operationId":"DeleteLoadBalancerVirtualServer"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LbVirtualServer"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Retrieve a load balancer virtual server.\n","parameters":[{"required":true,"type":"string","name":"virtual-server-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Retrieve a load balancer virtual server","x-vmw-nsx-module":"LoadBalancer","consumes":["application/json"],"operationId":"ReadLoadBalancerVirtualServer"}},"/node/services/liagent?action=restart":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the liagent service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","Log Insight"],"summary":"Restart, start or stop the liagent service","x-vmw-nsx-module":"NodeLiagentService","consumes":["application/json"],"operationId":"CreateLiagentServiceActionRestart"}},"/transport-zones/transport-node-status-report":{"get":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"You must provide the request header \"Accept:application/octet-stream\" when calling this API.","parameters":[{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"},{"description":"Transport node","enum":["UP","DOWN","DEGRADED"],"type":"string","name":"status","in":"query"}],"produces":["application/octet-stream"],"tags":["System Administration","Configuration","Fabric","Nodes","Transport Node Status"],"summary":"Creates a status report of transport nodes of all the transport zones","x-vmw-nsx-module":"Heatmap","consumes":["application/json"],"operationId":"GetTransportNodeReport"}},"/node/services/nsx-message-bus":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read NSX Message Bus service properties","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","NSX Message Service"],"summary":"Read NSX Message Bus service properties","x-vmw-nsx-module":"NodeNSXMessageBusService","consumes":["application/json"],"operationId":"ReadNSXMessageBusService"}},"/intrusion-services/affected-users":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IdsUserList"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"description":"Bad Request"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get the list of the users affected pertaining to a specific\nsignature.\n","parameters":[{"schema":{"$ref":"#/definitions/IDSEventDataRequest"},"required":true,"name":"IDSEventDataRequest","in":"body"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Security","Intrusion Services","Dashboard"],"summary":"Get the list of the users affected for that signature","x-vmw-nsx-module":"IDSMetrics","consumes":["application/json"],"operationId":"GetAffectedUsers"}},"/cluster/nodes/deployments/{node-id}":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ClusterNodeVMDeploymentRequest"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns deployment request information for a specific attempted\ndeployment of a cluster node VM.\n","parameters":[{"required":true,"type":"string","name":"node-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","NSX Managers","Clusters","Cluster Node Deployments"],"summary":"Returns info for a cluster-node VM auto-deployment attempt","x-vmw-nsx-module":"ClusterNodeVMDeployment","consumes":["application/json"],"operationId":"ReadClusterNodeVMDeploymentRequest"}},"/serviceinsertion/services/{service-id}/service-instances/{service-instance-id}/state":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ConfigurationState"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns configuration state of one instance of a deployed partner service using service insertion framework.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"required":true,"type":"string","name":"service-instance-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Get Service-Instance state for Service.","x-vmw-nsx-module":"ServiceInsertionVMDeployment","consumes":["application/json"],"operationId":"GetServiceInstanceState"}},"/fabric/cloud-native-service-instances":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/CloudNativeServiceInstanceListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about all cloud native service instances.","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Display Name of the cloud native service instance","required":false,"type":"string","name":"display_name","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"description":"Type of cloud native service; possible values are ELB, RDS","required":false,"type":"string","name":"service_type","in":"query"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"description":"NSX node id of the public cloud gateway that reported the service instance","required":false,"type":"string","name":"source","in":"query"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Cloud Native Service Instances"],"summary":"Returns the List of cloud native service instances","x-vmw-nsx-module":"InventoryCloudObj","consumes":["application/json"],"operationId":"ListAllCloudNativeServiceInstances"}},"/migration/migration-units/aggregate-info":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MigrationUnitAggregateInfoListResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get migration units aggregate-info","parameters":[{"description":"Component type based on which migration units to be filtered","required":false,"type":"string","name":"component_type","in":"query"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Identifier of group based on which migration units to be filtered","required":false,"type":"string","name":"group_id","in":"query"},{"description":"Flag to indicate whether to return only migration units with errors","default":false,"required":false,"in":"query","type":"boolean","name":"has_errors"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Metadata about migration unit to filter on","required":false,"type":"string","name":"metadata","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"enum":["SELECTED","DESELECTED","ALL"],"description":"Flag to indicate whether to return only selected, only deselected or both type of migration units","default":"ALL","required":false,"in":"query","type":"string","name":"selection_status"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Migration","Migration Units"],"summary":"Get migration units aggregate-info","x-vmw-nsx-module":"Migration","consumes":["application/json"],"operationId":"GetMigrationUnitAggregateInfo"}},"/node?action=set_system_time":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"409":{"description":"Conflict"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"description":"Internal Server Error"}},"description":"Set the node system time to the given time in UTC in the RFC3339 format\n'yyyy-mm-ddThh:mm:ssZ'.\n","parameters":[{"schema":{"$ref":"#/definitions/NodeTime"},"required":true,"name":"NodeTime","in":"body"}],"tags":["System Administration","Configuration","Fabric","Nodes","Settings"],"summary":"Set the node system time","x-vmw-nsx-module":"Node","consumes":["application/json"],"operationId":"SetNodeTimeSetSystemTime"}},"/ns-groups":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/NSGroup"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Creates a new NSGroup that can group NSX resources - VIFs, Lports\nand LSwitches as well as the grouping objects - IPSet, MACSet and other\nNSGroups.\nFor NSGroups containing VM criteria(both static and dynamic), system VMs will\nnot be included as members. This filter applies at VM level only.\nExceptions are as follows:\n1. LogicalPorts and VNI of System VMs will be included in NSGroup if the criteria\n is based on LogicalPort, LogicalSwitch or VNI directly.\n","parameters":[{"schema":{"$ref":"#/definitions/NSGroup"},"required":true,"name":"NSGroup","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Grouping Objects","NS Groups"],"summary":"Create NSGroup","x-vmw-nsx-module":"NSGroup","consumes":["application/json"],"operationId":"CreateNSGroup"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NSGroupListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"List the NSGroups in a paginated format. The page size is restricted\nto 50 NSGroups so that the size of the response remains small even\nin the worst case.\nOptionally, specify valid member types as request parameter to filter NSGroups.\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Specify member types to filter corresponding NSGroups\n","required":false,"type":"string","name":"member_types","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"default":false,"description":"Populate metadata of resource referenced by NSGroupExpressions\n","type":"boolean","name":"populate_references","in":"query"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Grouping Objects","NS Groups"],"summary":"List NSGroups","x-vmw-nsx-module":"NSGroup","consumes":["application/json"],"operationId":"ListNSGroups"}},"/serviceinsertion/service-attachments/{service-attachment-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ServiceAttachment"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Modifies an existing service attachment. Updates to\nname, description and Logical Router list only supported.\n","parameters":[{"required":true,"type":"string","name":"service-attachment-id","in":"path"},{"schema":{"$ref":"#/definitions/ServiceAttachment"},"required":true,"name":"ServiceAttachment","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Update an existing service attachment.","x-vmw-nsx-module":"ServiceInsertion","consumes":["application/json"],"operationId":"UpdateServiceAttachment"},"delete":{"responses":{"200":{"description":"OK"},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete existing service attachment from system.\nBefore deletion, please make sure that, no instance endpoints are connected\nto this attachment. In turn no appliance should be connected to this attachment.\n","parameters":[{"required":true,"type":"string","name":"service-attachment-id","in":"path"}],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Delete an existing service attachment","x-vmw-nsx-module":"ServiceInsertion","consumes":["application/json"],"operationId":"DeleteServiceAttachment"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ServiceAttachment"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns detailed Attachment information for a given service attachment.\n","parameters":[{"required":true,"type":"string","name":"service-attachment-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Get a particular service attachment.","x-vmw-nsx-module":"ServiceInsertion","consumes":["application/json"],"operationId":"GetServiceAttachment"}},"/transport-zones/transport-node-status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TransportNodeStatusListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read status of all the transport nodes","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"},{"description":"Transport node","enum":["UP","DOWN","DEGRADED","UNKNOWN"],"type":"string","name":"status","in":"query"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Transport Node Status"],"summary":"Read status of all the transport nodes","x-vmw-nsx-module":"Heatmap","consumes":["application/json"],"operationId":"ListTransportNodeStatus"}},"/pools/ip-pools/{pool-id}/allocations":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AllocationIpAddressListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about which addresses have been allocated from a\nspecified IP address pool.\n","parameters":[{"description":"IP pool ID","required":true,"type":"string","name":"pool-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Pool Management","IP Pools"],"summary":"List IP Pool Allocations","x-vmw-nsx-module":"Ipam","consumes":["application/json"],"operationId":"ListIpPoolAllocations"}},"/bridge-endpoints/{endpoint-id}/statistics":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BridgeEndpointStatistics"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get the statistics for the Bridge Endpoint of the given Endpoint id (endpoint-id)","parameters":[{"required":true,"type":"string","name":"endpoint-id","in":"path"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Bridging","Bridge Endpoints"],"summary":"Returns statistics of a specified Bridge Endpoint","x-vmw-nsx-module":"AggSvcBridging","consumes":["application/json"],"operationId":"GetBridgeEndpointStatistics"}},"/serviceinsertion/services/{service-id}/service-profiles/{service-profile-id}":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BaseServiceProfile"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns detailed service profile information for a given Service.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"required":true,"type":"string","name":"service-profile-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Get a particular ServiceProfile for a Service.","x-vmw-nsx-module":"ServiceInsertion","consumes":["application/json"],"operationId":"GetSIServiceProfile"},"delete":{"responses":{"200":{"description":"OK"},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete service profile for a given service.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"required":true,"type":"string","name":"service-profile-id","in":"path"}],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Delete a particular ServiceProfile.","x-vmw-nsx-module":"ServiceInsertion","consumes":["application/json"],"operationId":"DeleteSIServiceProfile"}},"/loadbalancer/persistence-profiles/{persistence-profile-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LbPersistenceProfile"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update a load balancer persistence profile.\n","parameters":[{"required":true,"type":"string","name":"persistence-profile-id","in":"path"},{"schema":{"$ref":"#/definitions/LbPersistenceProfile"},"required":true,"name":"LbPersistenceProfile","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Update a load balancer persistence profile","x-vmw-nsx-module":"LoadBalancer","consumes":["application/json"],"operationId":"UpdateLoadBalancerPersistenceProfile"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LbPersistenceProfile"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Retrieve a load balancer persistence profile.\n","parameters":[{"required":true,"type":"string","name":"persistence-profile-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Retrieve a load balancer persistence profile","x-vmw-nsx-module":"LoadBalancer","consumes":["application/json"],"operationId":"ReadLoadBalancerPersistenceProfile"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete a load balancer persistence profile.\n","parameters":[{"required":true,"type":"string","name":"persistence-profile-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Delete a load balancer persistence profile","x-vmw-nsx-module":"LoadBalancer","consumes":["application/json"],"operationId":"DeleteLoadBalancerPersistenceProfile"}},"/logical-routers/{logical-router-id}/routing/bgp":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BgpConfig"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Modifies the BGP configuration on a specified TIER0 logical router.\nModifiable parameters include enabled, graceful_restart, as_number.\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"},{"schema":{"$ref":"#/definitions/BgpConfig"},"required":true,"name":"BgpConfig","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Routing Configuration"],"summary":"Update the BGP Configuration on a Logical Router","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"UpdateBgpConfig"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BgpConfig"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about the BGP configuration on a specified logical\nrouter. Information includes whether or not the BGP configuration is\nenabled, the AS number, and whether or not graceful\nrestart is enabled.\n","parameters":[{"required":true,"type":"string","name":"logical-router-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Routing Configuration"],"summary":"Read the BGP Configuration on a Logical Router","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"ReadBgpConfig"}},"/node/services/async_replicator?action=restart":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the Async Replicator service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Async Replicator Service"],"summary":"Restart, start or stop the Async Replicator service","x-vmw-nsx-module":"NodeAsyncReplicatorService","consumes":["application/json"],"operationId":"CreateAsyncReplicatorServiceActionRestart"}},"/global-configs":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/GlobalConfigsListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns global configurations of a NSX domain grouped by the config types.\nThese global configurations are valid across NSX domain for their respective\ntypes unless they are overridden by a more granular configurations.\nThis rest routine is deprecated, and will be removed after a year.\n","produces":["application/json"],"tags":["System Administration","Configuration","Global Configurations"],"summary":"List global configurations of a NSX domain","x-vmw-nsx-module":"GlobalConfigs","consumes":["application/json"],"operationId":"ListGlobalConfigs"}},"/node/services/install-upgrade?action=stop":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"409":{"description":"Conflict"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the NSX install-upgrade service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Install Upgrade Service"],"summary":"Restart, start or stop the NSX install-upgrade service","x-vmw-nsx-module":"NodeInstallUpgradeService","consumes":["application/json"],"operationId":"CreateRepositoryServiceActionStop"}},"/serviceinsertion/service-chains/{service-chain-id}/service-paths":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ServicePathListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"description":"Internal Server Error"}},"description":"List all service paths for the given service chain for the given service chain id\nNOTE: GET service paths api is deprecated, please use the policy API.\n","parameters":[{"required":true,"type":"string","name":"service-chain-id","in":"path"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"List all service paths","x-vmw-nsx-module":"ServiceInsertion","consumes":["application/json"],"operationId":"ListServicePaths"}},"/migration/migration-units":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MigrationUnitListResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get migration units","parameters":[{"description":"Component type based on which migration units to be filtered","required":false,"type":"string","name":"component_type","in":"query"},{"description":"Current version of migration unit based on which migration units to be filtered","required":false,"type":"string","name":"current_version","in":"query"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"UUID of group based on which migration units to be filtered","required":false,"type":"string","name":"group_id","in":"query"},{"description":"Flag to indicate whether to return only migration units with warnings","default":false,"required":false,"in":"query","type":"boolean","name":"has_warnings"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Metadata about migration unit to filter on","required":false,"type":"string","name":"metadata","in":"query"},{"description":"Migration unit type based on which migration units to be filtered","required":false,"type":"string","name":"migration_unit_type","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Migration","Migration Units"],"summary":"Get migration units","x-vmw-nsx-module":"Migration","consumes":["application/json"],"operationId":"GetMigrationUnits"}},"/upgrade/functional-state":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UcFunctionalState"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get the functional state of the upgrade coordinator.\n","produces":["application/json"],"tags":["System Administration","Lifecycle Management","Upgrade","Status"],"summary":"Get functional state of the upgrade coordinator","x-vmw-nsx-module":"Upgrade","consumes":["application/json"],"operationId":"GetUcFunctionalState"}},"/logical-router-ports/{logical-router-port-id}/arp-table?format=csv":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LogicalRouterPortArpTableInCsvFormat"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns ARP table (IPv4) or Neighbor Discovery table (IPv6) in CSV format\nfor the Logical Router Port of the given id, on a node if a query\nparameter \"transport_node_id=<transport-node-id>\" is given. The\ntransport_node_id parameter is mandatory if the router port is not uplink\ntype. Query parameter \"source=realtime\" is the only supported source.\n","parameters":[{"required":true,"type":"string","name":"logical-router-port-id","in":"path"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"},{"description":"TransportNode Id","required":false,"type":"string","name":"transport_node_id","in":"query"}],"produces":["text/csv"],"tags":["Management Plane API","Networking","Logical Routing And Services","Logical Router Ports"],"summary":"Get the ARP table (IPv4) or Neighbor Discovery table (IPv6) for the\nLogical Router Port of the given id\n","x-vmw-nsx-module":"AggSvcLogicalRouterPort","consumes":["application/json"],"operationId":"GetLogicalRouterPortArpTableInCsvFormat"}},"/migration/switch":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MigrationSwitchInfo"}},"401":{"description":"Unauthorized"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"The user specifies a DVS / VSS as the current scope of migration.\n","parameters":[{"schema":{"$ref":"#/definitions/MigrationSwitchInfo"},"required":true,"name":"MigrationSwitchInfo","in":"body"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Migration","User Inputs"],"summary":"Set the switch as current scope for migration","x-vmw-nsx-module":"Migration","consumes":["application/json"],"operationId":"SetMigrationSwitch"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MigrationSwitchInfo"}},"401":{"description":"Unauthorized"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"The user is returned the switch (DVS/VSS) set as current scope of migration.\n","produces":["application/json"],"tags":["System Administration","Lifecycle Management","Migration","User Inputs"],"summary":"Get the switch set as current scope for migration","x-vmw-nsx-module":"Migration","consumes":["application/json"],"operationId":"GetMigrationSwitch"}},"/mirror-sessions/{mirror-session-id}?action=verify":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Verify whether all participants are on the same transport node","parameters":[{"required":true,"type":"string","name":"mirror-session-id","in":"path"}],"tags":["Management Plane API","Troubleshooting And Monitoring","Port Mirroring"],"summary":"Verify whether the mirror session is still valid","x-vmw-nsx-module":"PortMirroring","consumes":["application/json"],"operationId":"VerifyPortMirroringSession"}},"/node/services/nsx-upgrade-agent?action=stop":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the NSX upgrade agent service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","Upgrade Agent"],"summary":"Restart, start or stop the NSX upgrade agent service","x-vmw-nsx-module":"NodeNsxUpgradeAgent","consumes":["application/json"],"operationId":"CreateNsxUpgradeAgentServiceActionStop"}},"/node/services/applianceproxy":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read the Appliance Proxy service properties","produces":["application/json"],"tags":["Management Plane API","NSX Component Administration","Appliance Management"],"summary":"Read the Appliance Proxy service properties","x-vmw-nsx-module":"NodeApplProxy","consumes":["application/json"],"operationId":"ReadApplProxy"}},"/node/services/controller/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read controller service status","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Controller Service"],"summary":"Read controller service status","x-vmw-nsx-module":"NodeControllerServerService","consumes":["application/json"],"operationId":"ReadControllerServerServiceStatus"}},"/migration/migration-unit-groups/aggregate-info":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MigrationUnitGroupAggregateInfoListResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Return information of all migration unit groups in the\nmigration plan. If request parameter summary is set to true, then\nonly count of migration units will be returned, migration units list\nwill be empty. If request parameter component type is specified,\nthen all migration unit groups for that component will be returned.\n","parameters":[{"description":"Component type based on which migration unit groups to be filtered","required":false,"type":"string","name":"component_type","in":"query"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"description":"Flag indicating whether to return summary","default":false,"required":false,"in":"query","type":"boolean","name":"summary"},{"description":"Synchronize before returning migration unit groups","default":false,"required":false,"in":"query","type":"boolean","name":"sync"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Migration","Group"],"summary":"Return aggregate information of all migration unit groups","x-vmw-nsx-module":"Migration","consumes":["application/json"],"operationId":"GetMigrationUnitGroupAggregateInfo"}},"/node/services/node-stats/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read NSX node-stats service status","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Node Stats Service"],"summary":"Read NSX node-stats service status","x-vmw-nsx-module":"NodeNodeStatsService","consumes":["application/json"],"operationId":"ReadNodeStatsServiceStatus"}},"/cluster/api-certificate":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ClusterCertificateId"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the ID of the certificate that is used as the cluster certificate for MP\n","produces":["application/json"],"tags":["System Administration","Configuration","NSX Managers","Clusters","Cluster Certificate"],"summary":"Read cluster certificate ID","x-vmw-nsx-module":"ClusterCertificate","consumes":["application/json"],"operationId":"GetClusterCertificateId"}},"/upgrade/history":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UpgradeHistoryList"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get upgrade history","produces":["application/json"],"tags":["System Administration","Lifecycle Management","Upgrade","History"],"summary":"Get upgrade history","x-vmw-nsx-module":"Upgrade","consumes":["application/json"],"operationId":"GetUpgradeHistory"}},"/livetraces/{livetrace-session-id}/results":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LiveTraceResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get the result of a livetrace session","parameters":[{"required":true,"type":"string","name":"livetrace-session-id","in":"path"},{"enum":["TRACE","PKTCAP","COUNT"],"description":"The type of observations that will be listed.","required":false,"in":"query","type":"string","name":"action_type"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Troubleshooting And Monitoring","Livetrace"],"summary":"Get the result of a livetrace session","x-vmw-nsx-module":"LiveTrace","consumes":["application/json"],"operationId":"GetLiveTraceResult"}},"/transportzone-profiles":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/TransportZoneProfile"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Creates a transport zone profile. The resource_type is required.\nThis api is now deprecated. Please use new api -\nPUT /policy/api/v1/infra/transport-zone-profiles/<tz-profile>\n","parameters":[{"schema":{"$ref":"#/definitions/TransportZoneProfile"},"required":true,"name":"TransportZoneProfile","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Profiles","Transport Zone Profiles"],"summary":"Create a transport zone Profile","x-vmw-nsx-module":"TransportZoneProfile","consumes":["application/json"],"operationId":"CreateTransportZoneProfile"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TransportZoneProfileListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about the configured transport zone profiles. Transport zone\nprofiles define networking policies for transport zones and transport zone endpoints.\nThis api is now deprecated. Please use new api -\n/policy/api/v1/infra/transport-zone-profiles\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Whether the list result contains system resources","default":false,"required":false,"in":"query","type":"boolean","name":"include_system_owned"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"description":"comma-separated list of transport zone profile types, e.g. ?resource_type=BfdHealthMonitoringProfile","required":false,"type":"string","name":"resource_type","in":"query"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Profiles","Transport Zone Profiles"],"summary":"List transport zone profiles","x-vmw-nsx-module":"TransportZoneProfile","consumes":["application/json"],"operationId":"ListTransportZoneProfiles"}},"/transportzone-profiles/{transportzone-profile-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TransportZoneProfile"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Modifies a specified transport zone profile. The body of the PUT request must include the resource_type.\nThis api is now deprecated. Please use new api -\nPATCH /policy/api/v1/infra/transport-zone-profiles/<tz-profile>\n","parameters":[{"required":true,"type":"string","name":"transportzone-profile-id","in":"path"},{"schema":{"$ref":"#/definitions/TransportZoneProfile"},"required":true,"name":"TransportZoneProfile","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Profiles","Transport Zone Profiles"],"summary":"Update a transport zone profile","x-vmw-nsx-module":"TransportZoneProfile","consumes":["application/json"],"operationId":"UpdateTransportZoneProfile"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Deletes a specified transport zone profile. This api is now deprecated. Please use new api - DELETE /policy/api/v1/infra/transport-zone-profiles/<tz-profile>","parameters":[{"required":true,"type":"string","name":"transportzone-profile-id","in":"path"}],"tags":["System Administration","Configuration","Fabric","Profiles","Transport Zone Profiles"],"summary":"Delete a transport zone Profile","x-vmw-nsx-module":"TransportZoneProfile","consumes":["application/json"],"operationId":"DeleteTransportZoneProfile"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TransportZoneProfile"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about a specified transport zone profile. This api is now deprecated. Please use new api - /policy/api/v1/infra/transport-zone-profiles/<tz-profile>","parameters":[{"required":true,"type":"string","name":"transportzone-profile-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Profiles","Transport Zone Profiles"],"summary":"Get transport zone profile by identifier","x-vmw-nsx-module":"TransportZoneProfile","consumes":["application/json"],"operationId":"GetTransportZoneProfile"}},"/directory/domains/{domain-id}/groups/{group-id}/member-groups":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DirectoryGroupMemberListResults"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"A member group could be either direct member of the group specified by group_id or nested member of it. Both direct member groups and nested member groups are returned.","parameters":[{"description":"Directory domain identifier","required":true,"type":"string","name":"domain-id","in":"path"},{"description":"Directory group identifier","required":true,"type":"string","name":"group-id","in":"path"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["System Administration","Configuration","Directory Service","Groups"],"summary":"List members of a directory group","x-vmw-nsx-module":"DirectoryService","consumes":["application/json"],"operationId":"ListDirectoryGroupMemberGroups"}},"/logical-router-ports/{logical-router-port-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LogicalRouterPort"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Modifies the specified logical router port. Required parameters include the\nresource_type and logical_router_id. Modifiable parameters include the\nresource_type (LogicalRouterUpLinkPort, LogicalRouterDownLinkPort,\nLogicalRouterLinkPort, LogicalRouterLoopbackPort, LogicalRouterCentralizedServicePort),\nlogical_router_id (to reassign the port to a different router), and service_bindings.\n","parameters":[{"required":true,"type":"string","name":"logical-router-port-id","in":"path"},{"schema":{"$ref":"#/definitions/LogicalRouterPort"},"required":true,"name":"LogicalRouterPort","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Logical Router Ports"],"summary":"Update a Logical Router Port","x-vmw-nsx-module":"LogicalRouterPorts","consumes":["application/json"],"operationId":"UpdateLogicalRouterPort"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LogicalRouterPort"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about the specified logical router port.","parameters":[{"required":true,"type":"string","name":"logical-router-port-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Logical Router Ports"],"summary":"Read Logical Router Port","x-vmw-nsx-module":"LogicalRouterPorts","consumes":["application/json"],"operationId":"ReadLogicalRouterPort"},"delete":{"responses":{"200":{"description":"OK"},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Deletes the specified logical router port. You must delete logical router\nports before you can delete the associated logical router. To Delete Tier0\nrouter link port you must have to delete attached tier1 router link port,\notherwise pass \"force=true\" as query param to force delete the Tier0\nrouter link port.\n","parameters":[{"required":true,"type":"string","name":"logical-router-port-id","in":"path"},{"description":"Flag to specify whether to delete related logical switch ports","default":false,"required":false,"in":"query","type":"boolean","name":"cascade_delete_linked_ports"},{"default":false,"description":"Force delete the resource even if it is being used somewhere\n","type":"boolean","name":"force","in":"query"}],"tags":["Management Plane API","Networking","Logical Routing And Services","Logical Router Ports"],"summary":"Delete a Logical Router Port","x-vmw-nsx-module":"LogicalRouterPorts","consumes":["application/json"],"operationId":"DeleteLogicalRouterPort"}},"/serviceinsertion/services/{service-id}/service-instances":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BaseServiceInstance"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Adds a new Service-Instance under the specified Service.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"schema":{"$ref":"#/definitions/BaseServiceInstance"},"required":true,"name":"BaseServiceInstance","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Add a Service Instance for a specified Service.","x-vmw-nsx-module":"ServiceInsertion","consumes":["application/json"],"operationId":"AddServiceInstance"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ServiceInstanceListResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns all Service-Instance(s) for a given Service-Insertion Service.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Get all Service-Instances for Service.","x-vmw-nsx-module":"ServiceInsertion","consumes":["application/json"],"operationId":"ListServiceInstancesForService"}},"/transport-nodes/{edge-node-id}/inter-site/bgp/neighbors":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/BgpNeighborListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Paginated list of BGP Neighbors on edge transport node.\n","parameters":[{"required":true,"type":"string","name":"edge-node-id","in":"path"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Federation","Inter-Sites"],"summary":"Paginated list of BGP Neighbors on edge transport node","x-vmw-nsx-module":"AggSvcInterSite","consumes":["application/json"],"operationId":"ListInterSiteEdgeNodeBgpNeighbors"}},"/ipv6/nd-ra-profiles/{nd-ra-profile-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NDRAProfile"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update NDRAProfile\n","parameters":[{"required":true,"type":"string","name":"nd-ra-profile-id","in":"path"},{"schema":{"$ref":"#/definitions/NDRAProfile"},"required":true,"name":"NDRAProfile","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Routing Configuration"],"summary":"Update NDRA Profile","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"UpdateNDRAProfile"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete NDRAProfile\n","parameters":[{"required":true,"type":"string","name":"nd-ra-profile-id","in":"path"}],"tags":["Management Plane API","Networking","Logical Routing And Services","Routing Configuration"],"summary":"Delete NDRA Profile","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"DeleteNDRAProfile"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NDRAProfile"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about specified IPv6 NDRA Profile.\n","parameters":[{"required":true,"type":"string","name":"nd-ra-profile-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Logical Routing And Services","Routing Configuration"],"summary":"Read specified IPV6 NDRA Profile","x-vmw-nsx-module":"Routing","consumes":["application/json"],"operationId":"ReadNDRAProfile"}},"/idfw/user-stats/{user-id}":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IdfwUserStats"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get IDFW user login events for a given user (all active plus up to 5 most\nrecent archived entries).\n","parameters":[{"required":true,"type":"string","name":"user-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Security","Identity Firewall","Realization Data"],"summary":"Get IDFW user login events for a given user","x-vmw-nsx-module":"IdentityFirewall","consumes":["application/json"],"operationId":"GetUserStats"}},"/serviceinsertion/excludelist?action=remove_member":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResourceReference"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Note- POST serviceinsertion excludelist API is deprecated. Please use the\npolicy serviceinsertion excludelist API instead.\n","parameters":[{"in":"query","description":"Identifier of the object","required":true,"maxLength":64,"type":"string","name":"object_id"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Remove an existing object from the exclude list","x-vmw-nsx-module":"ServiceInsertionExcludeList","consumes":["application/json"],"operationId":"RemoveServiceInsertionExcludeListMember"}},"/node/services/controller/controller-certificate":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/CertificateKeyPair"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read controller server certificate properties","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Controller Service"],"summary":"Read controller server certificate properties","x-vmw-nsx-module":"ControllerServerCertificateModule","consumes":["application/json"],"operationId":"ReadControllerServerCertificate"}},"/serviceinsertion/services/{service-id}/service-instances/{service-instance-id}/instance-runtimes/{instance-runtime-id}/interfaces/{interface_index}/statistics":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RuntimeInterfaceStatistics"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns statistics of a specified interface via associated logical port. If the logical port is attached to\na logical router port, query parameter \"source=realtime\" is not supported.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"required":true,"type":"string","name":"service-instance-id","in":"path"},{"required":true,"type":"string","name":"instance-runtime-id","in":"path"},{"required":true,"type":"string","name":"interface_index","in":"path"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Get statistics for a given interface identified by the interface index","x-vmw-nsx-module":"ServiceInsertionVMDeployment","consumes":["application/json"],"operationId":"GetRuntimeInterfaceStatistics"}},"/upgrade/bundles?action=upload":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UpgradeBundleId"}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Upload the upgrade bundle. This call returns after upload is completed.\nYou can check bundle processing status periodically by retrieving upgrade\nbundle upload status to find out if the upload and processing is completed.\n","parameters":[{"description":"Upgrade bundle file","required":true,"type":"file","name":"file","in":"formData"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Upgrade","Bundles"],"summary":"Upload upgrade bundle","x-vmw-nsx-module":"Upgrade","consumes":["multipart/form-data"],"operationId":"UploadUpgradeBundleAsync"}},"/node/hardening-policy/mandatory-access-control":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MandatoryAccessControlProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Enable or disable Mandatory Access Control","parameters":[{"schema":{"$ref":"#/definitions/MandatoryAccessControlProperties"},"required":true,"name":"MandatoryAccessControlProperties","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Hardening","Mandatory Access Control"],"summary":"Enable or disable Mandatory Access Control","x-vmw-nsx-module":"NodeMandatoryAccessControlModule","consumes":["application/json"],"operationId":"SetNodeMandatoryAccessControl"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MandatoryAccessControlProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Gets the enable status for Mandatory Access Control","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Hardening","Mandatory Access Control"],"summary":"Gets the enable status for Mandatory Access Control","x-vmw-nsx-module":"NodeMandatoryAccessControlModule","consumes":["application/json"],"operationId":"GetNodeMandatoryAccessControl"}},"/node/services/install-upgrade":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeInstallUpgradeServiceProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"409":{"description":"Conflict"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update NSX install-upgrade service properties","parameters":[{"schema":{"$ref":"#/definitions/NodeInstallUpgradeServiceProperties"},"required":true,"name":"NodeInstallUpgradeServiceProperties","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Install Upgrade Service"],"summary":"Update NSX install-upgrade service properties","x-vmw-nsx-module":"NodeInstallUpgradeService","consumes":["application/json"],"operationId":"UpdateRepositoryService"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeInstallUpgradeServiceProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read NSX install-upgrade service properties","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Install Upgrade Service"],"summary":"Read NSX install-upgrade service properties","x-vmw-nsx-module":"NodeInstallUpgradeService","consumes":["application/json"],"operationId":"ReadRepositoryService"}},"/idfw/compute-collections/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IdfwComputeCollectionListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Retrieve all the Compute collection status.\n","produces":["application/json"],"tags":["Management Plane API","Security","Identity Firewall","Monitoring"],"summary":"List all IDFW enabled ComputeCollection statuses.","x-vmw-nsx-module":"IdentityFirewall","consumes":["application/json"],"operationId":"ListComputeCollectionStatuses"}},"/latency-profiles/{latency-profile-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LatencyStatProfile"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update an existing latency profile","parameters":[{"required":true,"type":"string","name":"latency-profile-id","in":"path"},{"schema":{"$ref":"#/definitions/LatencyStatProfile"},"required":true,"name":"LatencyStatProfile","in":"body"}],"produces":["application/json"],"tags":["System Administration","Monitoring","Latency Profiles"],"summary":"Update an existing latency profile","x-vmw-nsx-module":"Latency","consumes":["application/json"],"operationId":"UpdateLatencyProfile"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete an existing latency profile","parameters":[{"required":true,"type":"string","name":"latency-profile-id","in":"path"}],"tags":["System Administration","Monitoring","Latency Profiles"],"summary":"Delete an existing latency profile","x-vmw-nsx-module":"Latency","consumes":["application/json"],"operationId":"DeleteLatencyStatProfile"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LatencyStatProfile"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get an existing latency profile configuration","parameters":[{"required":true,"type":"string","name":"latency-profile-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Monitoring","Latency Profiles"],"summary":"Get an existing latency profile configuration","x-vmw-nsx-module":"Latency","consumes":["application/json"],"operationId":"ReadLatencyStatProfile"}},"/node":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Modifies NSX appliance properties. Modifiable properties include the\ntimezone, message of the day (motd), and hostname. The NSX appliance\nnode_version, system_time, and kernel_version are read only and cannot be\nmodified with this method.\n","parameters":[{"schema":{"$ref":"#/definitions/NodeProperties"},"required":true,"name":"NodeProperties","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Settings"],"summary":"Update node properties","x-vmw-nsx-module":"Node","consumes":["application/json"],"operationId":"UpdateNodeProperties"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about the NSX appliance. Information includes\nrelease number, time zone, system time, kernel version, message of the day\n(motd), and host name.\n","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Settings"],"summary":"Read node properties","x-vmw-nsx-module":"Node","consumes":["application/json"],"operationId":"ReadNodeProperties"}},"/node/services/applianceproxy/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read the Appliance Proxy service status","produces":["application/json"],"tags":["Management Plane API","NSX Component Administration","Appliance Management"],"summary":"Read the Appliance Proxy service status","x-vmw-nsx-module":"NodeApplProxy","consumes":["application/json"],"operationId":"ReadApplProxyStatus"}},"/serviceinsertion/service-chains":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ServiceChain"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Adds a new service chain. Service Chains is can contain profile belonging\nto same or different Service(s). It represents a redirection target for a Rule.\n","parameters":[{"schema":{"$ref":"#/definitions/ServiceChain"},"required":true,"name":"ServiceChain","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"Add Service Chain","x-vmw-nsx-module":"ServiceInsertion","consumes":["application/json"],"operationId":"AddServiceChain"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ServiceChainListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"List all service chains in the system.\n","produces":["application/json"],"tags":["Management Plane API","Security","Services","Service Insertion"],"summary":"List all ServiceChains.","x-vmw-nsx-module":"ServiceInsertion","consumes":["application/json"],"operationId":"ListServiceChains"}},"/migration/migration-units/{migration-unit-id}":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MigrationUnit"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get a specific migration unit","parameters":[{"required":true,"type":"string","name":"migration-unit-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Migration","Migration Units"],"summary":"Get a specific migration unit","x-vmw-nsx-module":"Migration","consumes":["application/json"],"operationId":"GetMigrationUnit"}},"/upgrade/plan/{component_type}/settings":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UpgradePlanSettings"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"description":"Bad Request"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update the upgrade plan settings for the component.\n","parameters":[{"required":true,"type":"string","name":"component_type","in":"path"},{"schema":{"$ref":"#/definitions/UpgradePlanSettings"},"required":true,"name":"UpgradePlanSettings","in":"body"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Upgrade","Plan"],"summary":"Update upgrade plan settings for the component","x-vmw-nsx-module":"Upgrade","consumes":["application/json"],"operationId":"UpdateUpgradePlanSettings"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UpgradePlanSettings"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get the upgrade plan settings for the component.\n","parameters":[{"required":true,"type":"string","name":"component_type","in":"path"}],"produces":["application/json"],"tags":["System Administration","Lifecycle Management","Upgrade","Plan"],"summary":"Get upgrade plan settings for the component","x-vmw-nsx-module":"Upgrade","consumes":["application/json"],"operationId":"GetUpgradePlanSettings"}},"/loadbalancer/services/{service-id}/pools/{pool-id}/statistics":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LbPoolStatistics"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns the statistics of the given load balancer pool by given load balancer\nserives id and load balancer pool id.\nCurrently, only realtime mode is supported.\n","parameters":[{"required":true,"type":"string","name":"service-id","in":"path"},{"required":true,"type":"string","name":"pool-id","in":"path"},{"enum":["realtime","cached"],"description":"Data source type.","required":false,"in":"query","type":"string","name":"source"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Get the statistics of load balancer pool","x-vmw-nsx-module":"AggSvcLb","consumes":["application/json"],"operationId":"GetLoadBalancerPoolStatistics"}},"/fabric/virtual-machines/tools-info":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/VmToolsInfoListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"This API returns the list of tools and agents installed in VMs.","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Policy","Inventory","Virtual Machines"],"summary":"Return the list of tools and agents installed in VMs.","x-vmw-nsx-module":"VmToolsInfo","consumes":["application/json"],"operationId":"ListVmToolsInfo"}},"/vpn/ipsec/tunnel-profiles":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/IPSecVPNTunnelProfile"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Create custom IPSec tunnel profile. IPSec tunnel profile is a reusable profile that captures phase two negotiation parameters and tunnel properties. System will be provisioned with system owned non editable default IPSec tunnel profile. Any change in profile affects all sessions consuming this profile.","parameters":[{"schema":{"$ref":"#/definitions/IPSecVPNTunnelProfile"},"required":true,"name":"IPSecVPNTunnelProfile","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","VPN","IPSEC","Tunnel Profiles"],"summary":"Create custom IPSec tunnel profile","x-vmw-nsx-module":"IPSecVPN","consumes":["application/json"],"operationId":"CreateIPSecVPNTunnelProfile"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/IPSecVPNTunnelProfileListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get paginated list of all IPSecTunnelProfiles.","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","VPN","IPSEC","Tunnel Profiles"],"summary":"Get IPSecTunnelProfile List Result","x-vmw-nsx-module":"IPSecVPN","consumes":["application/json"],"operationId":"ListIPSecVPNTunnelProfiles"}},"/node/services/http":{"put":{"responses":{"202":{"description":"Accepted","schema":{"$ref":"#/definitions/NodeHttpServiceProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"This API is deprecated. Make changes to the http service\nconfiguration by calling the PUT /api/v1/cluster/api-service API.\n","parameters":[{"schema":{"$ref":"#/definitions/NodeHttpServiceProperties"},"required":true,"name":"NodeHttpServiceProperties","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","HTTP Service"],"summary":"Update http service properties","x-vmw-nsx-module":"NodeProxyService","consumes":["application/json"],"operationId":"UpdateProxyService"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeHttpServiceProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"This API is deprecated. Read the configuration of the\nhttp service by calling the GET /api/v1/cluster/api-service API.\n","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","HTTP Service"],"summary":"Read http service properties","x-vmw-nsx-module":"NodeProxyService","consumes":["application/json"],"operationId":"ReadProxyService"}},"/migration/feedback-response":{"put":{"responses":{"200":{"description":"OK"},"401":{"description":"Unauthorized"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Provide response for feedback queries needed for migration.\n","parameters":[{"schema":{"$ref":"#/definitions/MigrationFeedbackResponseList"},"required":true,"name":"MigrationFeedbackResponseList","in":"body"},{"enum":["L2","L3_L7"],"description":"Network layer for which feedback is generated","required":false,"in":"query","type":"string","name":"network_layer"}],"tags":["System Administration","Lifecycle Management","Migration","Feedback"],"summary":"Migration feedback response","x-vmw-nsx-module":"Migration","consumes":["application/json"],"operationId":"UpdateFeedbackResponse"}},"/upgrade/eula/acceptance":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EULAAcceptance"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Return the acceptance status of end user license agreement\n","produces":["application/json"],"tags":["System Administration","Lifecycle Management","Upgrade","Eula"],"summary":"Return the acceptance status of end user license agreement\n","x-vmw-nsx-module":"UpgradeEULA","consumes":["application/json"],"operationId":"GetUpgradeEULAAcceptance"}},"/loadbalancer/client-ssl-profiles":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/LbClientSslProfile"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Create a load balancer client-ssl profile.\n","parameters":[{"schema":{"$ref":"#/definitions/LbClientSslProfile"},"required":true,"name":"LbClientSslProfile","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Create a load balancer client-ssl profile","x-vmw-nsx-module":"LoadBalancer","consumes":["application/json"],"operationId":"CreateLoadBalancerClientSslProfile"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LbClientSslProfileListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Retrieve a paginated list of load balancer client-ssl profiles.\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Retrieve a paginated list of load balancer client-ssl profiles","x-vmw-nsx-module":"LoadBalancer","consumes":["application/json"],"operationId":"ListLoadBalancerClientSslProfiles"}},"/node/services/nsx-platform-client?action=start":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the NSX Platform Client service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","NSX Platform Client"],"summary":"Restart, start or stop the NSX Platform Client service","x-vmw-nsx-module":"NodePlatformClientService","consumes":["application/json"],"operationId":"CreatePlatformClientServiceActionStart"}},"/transport-nodes/state":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TransportNodeStateListResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns a list of transport node states that have realized state as provided\nas query parameter. This api is now deprecated. Please use new api -\n/infra/sites/<site-id>/enforcement-points/<enforcementpoint-\nid>/host-transport-nodes/state\n","parameters":[{"enum":["ENTERING","ENABLED","EXITING","DISABLED"],"description":"maintenance mode state","required":false,"in":"query","type":"string","name":"mm_state"},{"enum":["PENDING","IN_PROGRESS","SUCCESS","PARTIAL_SUCCESS","FAILED","ORPHANED"],"description":"Realized state of transport nodes","required":false,"in":"query","type":"string","name":"status"},{"description":"Virtual tunnel endpoint ip address of transport node","required":false,"type":"string","name":"vtep_ip","in":"query"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Transport Nodes"],"summary":"List transport nodes by realized state","x-vmw-nsx-module":"TransportNodeLcm","consumes":["application/json"],"operationId":"ListTransportNodesByStateWithDeploymentInfo"}},"/node/processes/{process-id}":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeProcessProperties"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information for a specified process ID (pid).","parameters":[{"description":"ID of process to read","required":true,"type":"string","name":"process-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Settings"],"summary":"Read node process","x-vmw-nsx-module":"NodeProcesses","consumes":["application/json"],"operationId":"ReadNodeProcess"}},"/systemhealth/plugins/status/{node-id}":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PluginStatusList"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Show all the installed system health plugins on given node\n","parameters":[{"required":true,"type":"string","name":"node-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Monitoring","System Health","Plugins"],"summary":"Show the installed system health plugin list","x-vmw-nsx-module":"SystemHealthPlugin","consumes":["application/json"],"operationId":"ShowSystemHealthPluginOnNode"}},"/node/services/liagent?action=start":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the liagent service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","Log Insight"],"summary":"Restart, start or stop the liagent service","x-vmw-nsx-module":"NodeLiagentService","consumes":["application/json"],"operationId":"CreateLiagentServiceActionStart"}},"/upgrade/plan?action=reset":{"post":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Reset the upgrade plan to default plan. User has an option to change\nthe default plan. But if after making changes, user wants to go\nback to the default plan, this is the way to do so.\n","parameters":[{"description":"Component type","required":true,"type":"string","name":"component_type","in":"query"}],"tags":["System Administration","Lifecycle Management","Upgrade","Plan"],"summary":"Reset upgrade plan to default plan","x-vmw-nsx-module":"Upgrade","consumes":["application/json"],"operationId":"ResetUpgradePlan"}},"/fabric/discovered-nodes":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DiscoveredNodeListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about all discovered nodes.","parameters":[{"description":"Local Id of the discovered node in the Compute Manager","required":false,"type":"string","name":"cm_local_id","in":"query"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Display name of discovered node","required":false,"type":"string","name":"display_name","in":"query"},{"description":"External id of the discovered node, ex. a mo-ref from VC","required":false,"type":"string","name":"external_id","in":"query"},{"enum":["true","false"],"description":"Discovered node has a parent compute collection or is a standalone host","required":false,"in":"query","type":"string","name":"has_parent"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"IP address of the discovered node","required":false,"type":"string","name":"ip_address","in":"query"},{"description":"Id of the fabric node created from the discovered node","required":false,"type":"string","name":"node_id","in":"query"},{"description":"Discovered Node type like HostNode","required":false,"type":"string","name":"node_type","in":"query"},{"description":"Id of the compute manager from where this node was discovered","required":false,"type":"string","name":"origin_id","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"description":"External id of the compute collection to which this node belongs","required":false,"type":"string","name":"parent_compute_collection","in":"query"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Discovered Nodes"],"summary":"Return the List of Discovered Nodes","x-vmw-nsx-module":"InventoryCmObj","consumes":["application/json"],"operationId":"ListDiscoveredNodes"}},"/tasks/{task-id}/response":{"get":{"responses":{"200":{"description":"OK","schema":{"type":"object"}},"303":{"description":"See Other","schema":{"type":"object"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get the response of a task","parameters":[{"description":"ID of task to read","required":true,"type":"string","name":"task-id","in":"path"}],"produces":["application/json"],"tags":["System Administration","Configuration","NSX Managers","API Services","Task Management"],"summary":"Get the response of a task","x-vmw-nsx-module":"Tasks","consumes":["application/json"],"operationId":"ReadTaskResult"}},"/aaa/registration-token/{token}":{"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Delete registration access token","parameters":[{"description":"Registration token","required":true,"type":"string","name":"token","in":"path"}],"produces":["application/json"],"tags":["System Administration","Settings","User Management","Access Token"],"summary":"Delete registration access token","x-vmw-nsx-module":"RegistrationTokenEndPoint","consumes":["application/json"],"operationId":"DeleteRegistrationToken"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RegistrationToken"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get registration access token","parameters":[{"description":"Registration token","required":true,"type":"string","name":"token","in":"path"}],"produces":["application/json"],"tags":["System Administration","Settings","User Management","Access Token"],"summary":"Get registration access token","x-vmw-nsx-module":"RegistrationTokenEndPoint","consumes":["application/json"],"operationId":"GetRegistrationToken"}},"/ns-profiles":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/NSProfile"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Creates a new NSProfile which allows users to encapsulate attribute and\nsub-attributes of network services.\nRules for using attributes and sub-attributes in single NSProfile\n1. One type of attribute can't have multiple occurrences. ( Example -\n Attribute type APP_ID can be used only once per NSProfile.)\n2. Values for an attribute are mentioned as array of strings.\n ( Example - For type APP_ID , values can be mentioned as [\"SSL\",\"FTP\"].)\n3. If sub-attribtes are mentioned for an attribute, then only single\n value is allowed for that attribute.\n4. To get a list of supported\n attributes and sub-attributes fire the following REST API\n GET https://<nsx-mgr>/api/v1/ns-profiles/attributes\n","parameters":[{"schema":{"$ref":"#/definitions/NSProfile"},"required":true,"name":"NSProfile","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Grouping Objects","NS Groups"],"summary":"Create NSProfile","x-vmw-nsx-module":"NSProfile","consumes":["application/json"],"operationId":"CreateNSProfile"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NSProfileListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"List the NSProfiles created in a paginated format.The page size is restricted\nto 50 NSProfiles, so that the size of the response remains small even\nwhen there are high number of NSProfiles with multiple attributes and\nmultiple attribute values for each attribute.\n","parameters":[{"description":"Fetch NSProfiles for the given attribute type","required":false,"type":"string","name":"attribute_type","in":"query"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Grouping Objects","NS Profiles"],"summary":"List NSProfiles","x-vmw-nsx-module":"NSProfile","consumes":["application/json"],"operationId":"ListNSProfiles"}},"/node/services/controller?action=restart":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the controller service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","NSX Manager","Services","Controller Service"],"summary":"Restart, start or stop the controller service","x-vmw-nsx-module":"NodeControllerServerService","consumes":["application/json"],"operationId":"CreateControllerServerServiceActionRestart"}},"/ns-profiles/{ns-profile-id}":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NSProfile"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Updates the specified NSProfile.\nRules for using attributes and sub-attributes in single NSProfile\n1. One type of attribute can't have multiple occurrences. ( Example -\n Attribute type APP_ID can be used only once per NSProfile.)\n2. Values for an attribute are mentioned as array of strings.\n ( Example - For type APP_ID , values can be mentioned as [\"SSL\",\"FTP\"].)\n3. If sub-attribtes are mentioned for an attribute, then only single\n value is allowed for that attribute.\n4. To get a list of supported\n attributes and sub-attributes fire the following REST API\n GET https://<nsx-mgr>/api/v1/ns-profiles/attributes\n","parameters":[{"description":"NSProfile Id","required":true,"type":"string","name":"ns-profile-id","in":"path"},{"schema":{"$ref":"#/definitions/NSProfile"},"required":true,"name":"NSProfile","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Grouping Objects","NS Profiles"],"summary":"Update NSProfile","x-vmw-nsx-module":"NSProfile","consumes":["application/json"],"operationId":"UpdateNSProfile"},"delete":{"responses":{"200":{"description":"OK"},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Deletes the specified NSProfile. By default, if the NSProfile is\nconsumed in a Firewall rule, it won't get deleted. In such\nsituations, pass \"force=true\" as query param to force delete\nthe NSProfile.\n","parameters":[{"description":"NSProfile Id","required":true,"type":"string","name":"ns-profile-id","in":"path"},{"default":false,"description":"Force delete the resource even if it is being used somewhere\n","type":"boolean","name":"force","in":"query"}],"tags":["Management Plane API","Grouping Objects","NS Profiles"],"summary":"Delete NSProfile","x-vmw-nsx-module":"NSProfile","consumes":["application/json"],"operationId":"DeleteNSProfile"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NSProfile"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about the specified NSProfile.\n","parameters":[{"description":"NSProfile Id","required":true,"type":"string","name":"ns-profile-id","in":"path"}],"produces":["application/json"],"tags":["Management Plane API","Grouping Objects","NS Profiles"],"summary":"Read NSProfile","x-vmw-nsx-module":"NSProfile","consumes":["application/json"],"operationId":"ReadNSProfile"}},"/loadbalancer/virtual-servers":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/LbVirtualServer"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Create a load balancer virtual server.\n","parameters":[{"schema":{"$ref":"#/definitions/LbVirtualServer"},"required":true,"name":"LbVirtualServer","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Create a load balancer virtual server","x-vmw-nsx-module":"LoadBalancer","consumes":["application/json"],"operationId":"CreateLoadBalancerVirtualServer"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/LbVirtualServerListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Retrieve a paginated list of load balancer virtual servers.\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Retrieve a paginated list of load balancer virtual servers","x-vmw-nsx-module":"LoadBalancer","consumes":["application/json"],"operationId":"ListLoadBalancerVirtualServers"}},"/node/status":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns information about the node appliance's file system, CPU,\nmemory, disk usage, and uptime.\n","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Settings"],"summary":"Read node status","x-vmw-nsx-module":"NodeStatus","consumes":["application/json"],"operationId":"ReadApplianceNodeStatus"}},"/node/network/routes":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/NodeRouteProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"409":{"description":"Conflict"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Add a route to the node routing table. For static routes, the\nroute_type, interface_id, netmask, and destination are required parameters.\nFor default routes, the route_type, gateway address, and interface_id\nare required. For blackhole routes, the route_type and destination are\nrequired. All other parameters are optional. When you add a static route,\nthe scope and route_id are created automatically. When you add a default or\nblackhole route, the route_id is created automatically. The route_id is\nread-only, meaning that it cannot be modified. All other properties can be\nmodified by deleting and readding the route.\n","parameters":[{"schema":{"$ref":"#/definitions/NodeRouteProperties"},"required":true,"name":"NodeRouteProperties","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Network Interfaces","Routing"],"summary":"Create node network route","x-vmw-nsx-module":"NodeNetworkRoutesModule","consumes":["application/json"],"operationId":"CreateNodeNetworkRoute"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeRoutePropertiesListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns detailed information about each route in the node routing\ntable. Route information includes the route type (default, static, and so\non), a unique route identifier, the route metric, the protocol from which\nthe route was learned, the route source (which is the preferred egress\ninterface), the route destination, and the route scope. The route scope\nrefers to the distance to the destination network: The \"host\" scope leads to\na destination address on the node, such as a loopback address;\nthe \"link\" scope leads to a destination on the local network; and the\n\"global\" scope leads to addresses that are more than one hop away.\n","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Network Interfaces","Routing"],"summary":"List node network routes","x-vmw-nsx-module":"NodeNetworkRoutesModule","consumes":["application/json"],"operationId":"ListNodeNetworkRoutes"}},"/trust-management/crl-distribution-points/pem-file":{"post":{"responses":{"200":{"description":"OK","schema":{"type":"string"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Return stored CRL in PEM format","parameters":[{"schema":{"$ref":"#/definitions/CrlPemRequestType"},"required":true,"name":"CrlPemRequestType","in":"body"}],"produces":["text/plain;charset=UTF-8"],"tags":["System Administration","Settings","Certificates","CRL"],"summary":"Return stored CRL in PEM format","x-vmw-nsx-module":"CertificateManager","consumes":["application/json"],"operationId":"GetCrlDistributionPointPem"}},"/node/services/snmp/v3-engine-id":{"put":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeSnmpV3EngineID"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Update SNMP V3 Engine ID","parameters":[{"schema":{"$ref":"#/definitions/NodeSnmpV3EngineID"},"required":true,"name":"NodeSnmpV3EngineID","in":"body"}],"produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","SNMP"],"summary":"Update SNMP V3 Engine ID","x-vmw-nsx-module":"NodeSNMPService","consumes":["application/json"],"operationId":"UpdateSNMPV3EngineID"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeSnmpV3EngineID"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Read SNMP V3 Engine ID","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","SNMP"],"summary":"Read SNMP V3 Engine ID","x-vmw-nsx-module":"NodeSNMPService","consumes":["application/json"],"operationId":"ReadSNMPV3EngineID"}},"/ns-profiles/attributes":{"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NSSupportedAttributesListResult"}},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Returns supported attribute and sub-attributes for specified\nattribute type with their supported values, if provided in query/request\nparameter, else will fetch all supported attribute and sub-attributes for\nall supported attribute types.\n","parameters":[{"enum":["SYSTEM","CUSTOM","ALL"],"description":"Fetch attributes source","required":false,"in":"query","type":"string","name":"attribute_source"},{"description":"Fetch attributes and sub-attributes for the given attribute type","required":false,"type":"string","name":"attribute_type","in":"query"},{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"}],"produces":["application/json"],"tags":["Management Plane API","Grouping Objects","NS Profiles"],"summary":"List NSProfile supported attribute and sub-attributes","x-vmw-nsx-module":"NSProfile","consumes":["application/json"],"operationId":"ListNSSupportedAttributes"}},"/fabric/virtual-machines?action=add_tags":{"post":{"responses":{"204":{"description":"No Content"},"404":{"description":"Not Found"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Perform action on a specific virtual machine. External id of the virtual machine needs to be\nprovided in the request body. Some of the actions that can be performed are update tags, add\ntags, remove tags.\nTo add tags to existing list of tag, use action parameter add_tags.\nTo remove tags from existing list of tag, use action parameter remove_tags.\nTo replace existing tags with new tags, use action parameter update_tags.\nTo clear all tags, provide an empty list and action parameter as update_tags.\nThe vmw-async: True HTTP header cannot be used with this API.\n","parameters":[{"schema":{"$ref":"#/definitions/VirtualMachineTagUpdate"},"required":true,"name":"VirtualMachineTagUpdate","in":"body"}],"tags":["Policy","Inventory","Virtual Machines"],"summary":"Perform action on specified virtual machine e.g. update tags","x-vmw-nsx-module":"InventoryVmTag","consumes":["application/json"],"operationId":"AddVirtualMachineTags"}},"/node/services/nsx-platform-client?action=stop":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NodeServiceStatusProperties"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Restart, start or stop the NSX Platform Client service","produces":["application/json"],"tags":["System Administration","Configuration","Fabric","Nodes","Services","NSX Platform Client"],"summary":"Restart, start or stop the NSX Platform Client service","x-vmw-nsx-module":"NodePlatformClientService","consumes":["application/json"],"operationId":"CreatePlatformClientServiceActionStop"}},"/loadbalancer/virtual-servers?action=create_with_rules":{"post":{"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/LbVirtualServerWithRule"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"It is used to create virtual servers, the associated rules and bind the\nrules to the virtual server.\nTo add new rules, make sure the rules which have no identifier specified,\nthe new rules are automatically generated and associated to the virtual\nserver.\nIf the virtual server need to consume some existed rules without change,\nthose rules should not be specified in this array, otherwise, the rules\nare updated.\n","parameters":[{"schema":{"$ref":"#/definitions/LbVirtualServerWithRule"},"required":true,"name":"LbVirtualServerWithRule","in":"body"}],"produces":["application/json"],"tags":["Management Plane API","Networking","Services","Loadbalancer"],"summary":"Create a load balancer virtual server with rules","x-vmw-nsx-module":"LoadBalancer","consumes":["application/json"],"operationId":"CreateLoadBalancerVirtualServerWithRules"}},"/aaa/role-bindings":{"post":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RoleBinding"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"This API is used to assign a user/group any role(s) of choice.\nUser has union of all the roles assigned to it. User name is\ndealt case-insensitively.\n","parameters":[{"schema":{"$ref":"#/definitions/RoleBinding"},"required":true,"name":"RoleBinding","in":"body"}],"produces":["application/json"],"tags":["System Administration","Settings","User Management","Roles"],"summary":"Assign roles to User or Group","x-vmw-nsx-module":"AAA","consumes":["application/json"],"operationId":"CreateRoleBinding"},"get":{"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RoleBindingListResult"}},"404":{"$ref":"#/responses/NotFound"},"403":{"$ref":"#/responses/Forbidden"},"412":{"$ref":"#/responses/PreconditionFailed"},"400":{"$ref":"#/responses/BadRequest"},"503":{"$ref":"#/responses/ServiceUnavailable"},"500":{"$ref":"#/responses/InternalServerError"}},"description":"Get all users and groups with their roles.\n","parameters":[{"description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","type":"string","name":"cursor","in":"query"},{"description":"Identity source ID","required":false,"type":"string","name":"identity_source_id","in":"query"},{"enum":["VIDM","LDAP","OIDC"],"description":"Identity source type","required":false,"in":"query","type":"string","name":"identity_source_type"},{"description":"Comma separated list of fields that should be included in query result","type":"string","name":"included_fields","in":"query"},{"description":"User/Group name","required":false,"type":"string","name":"name","in":"query"},{"description":"Maximum number of results to return in this page (server may return fewer)","format":"int64","default":1000,"maximum":1000,"minimum":0,"in":"query","type":"integer","name":"page_size"},{"description":"Role ID","required":false,"type":"string","name":"role","in":"query"},{"type":"boolean","name":"sort_ascending","in":"query"},{"description":"Field by which records are sorted","type":"string","name":"sort_by","in":"query"},{"enum":["remote_user","remote_group","local_user","principal_identity"],"description":"Type","required":false,"in":"query","type":"string","name":"type"}],"produces":["application/json"],"tags":["System Administration","Settings","User Management","Roles"],"summary":"Get all users and groups with their roles","x-vmw-nsx-module":"AAA","consumes":["application/json"],"operationId":"GetAllRoleBindings"}}},"definitions":{"ClusterNode":{"description":"This type contains attributes of a cluster node that are relevant to the Cluster Boot Manager.","title":"Cluster Node Properties","required":["entities","node_uuid"],"x-vmw-nsx-module":"Cluster","type":"object","properties":{"status":{"default":"REMOVED","enum":["JOINING","JOINED","REMOVING","REMOVED"],"type":"string","description":"Current clustering status of the node","title":"Current clustering status of the node"},"entities":{"items":{"$ref":"#/definitions/ClusterNodeEntity"},"type":"array","description":"Entities on the node","title":"Entities on the node"},"node_uuid":{"type":"string","description":"UUID of the node","title":"UUID of the node"}}},"InterfacePimConfig":{"x-vmw-nsx-module":"LogicalRouterPorts","type":"object","description":"Interface PIM[Protocol Independent Multicast] configuration parameters.\n","properties":{"hold_interval":{"description":"PIM hold interval. Ranges from 1 to 630 seconds. hold_interval\nshould be greater than hello_interval.\nIf hold interval is not provided then it will be considered as\n3.5 times of hello_interval.\n","format":"int64","title":"PIM hold interval","maximum":630,"minimum":1,"type":"integer"},"enabled":{"default":false,"type":"boolean","description":"If the flag is set to true - it will enable PIM on\nthe uplink interface. If the flag is set to false - it will disable\nPIM on the uplink interface.\n","title":"Flag to enable/disable PIM"},"hello_interval":{"description":"PIM hello interval. Ranges from 1 to 180 seconds.\n","title":"PIM hello interval","default":30,"format":"int64","maximum":180,"minimum":1,"type":"integer"}},"title":"Interface PIM configuration"},"NDRAProfile":{"x-vmw-nsx-module":"Routing","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"Routing","required":["ra_mode","ra_config"],"type":"object","properties":{"ra_mode":{"description":"RA Mode","default":"SLAAC_DNS_THROUGH_RA","enum":["DISABLED","SLAAC_DNS_THROUGH_RA","SLAAC_DNS_THROUGH_DHCP","DHCP_ADDRESS_AND_DNS_THROUGH_DHCP","SLAAC_AND_ADDRESS_DNS_THROUGH_DHCP"],"type":"string"},"ra_config":{"$ref":"#/definitions/RAConfig"},"retransmit_interval":{"description":"The time, in milliseconds, between retransmitted neighbour\nsolicitation messages.\n","title":"Retransmission interval","default":1000,"format":"int64","maximum":4294967295,"minimum":0,"type":"integer"},"ndra_advertised_route":{"items":{"$ref":"#/definitions/NDRAAdvertisedRoute"},"type":"array","description":"Route advertised in NDRAProfile.\n"},"dns_config":{"$ref":"#/definitions/RaDNSConfig"},"reachable_timer":{"description":"Neighbour reachable time duration in milliseconds.\nA value of 0 means unspecified.\n","title":"Reachable timer","default":0,"format":"int64","maximum":3600000,"minimum":0,"type":"integer"}}}]},"RowListField":{"description":"Root of the api result set for forming rows.","title":"List of fields from which rows are formed","required":["path"],"x-vmw-nsx-module":"NsxDashboard","type":"object","properties":{"alias":{"maxLength":255,"type":"string","description":"Short name or alias of row list field, if any. If unspecified, the row list field can be referenced by its index in the array of row list fields as $ (for example, $0).","title":"Alias Name"},"path":{"maxLength":1024,"type":"string","description":"JSON path to the root of the api result set for forming rows.","title":"JSON path"}}},"TrustManagementData":{"x-vmw-nsx-module":"CertificateManager","type":"object","properties":{"supported_algorithms":{"items":{"$ref":"#/definitions/CryptoAlgorithm"},"readOnly":true,"type":"array","description":"List of supported algorithms."}}},"ContainerClusterStatus":{"x-vmw-nsx-module":"TnContainerStatus","type":"object","properties":{"status":{"description":"Display the container cluster status.","enum":["UNKNOWN","HEALTHY","DOWN","DEGRADED"],"type":"string"},"interval":{"description":"Display the cluster check interval in seconds.","title":"Container cluster status check interval","format":"int32","maximum":600,"readOnly":true,"minimum":60,"type":"integer"},"cluster_id":{"type":"string","description":"Identifier of the container cluster.","title":"Identifier of the container cluster"},"detail":{"type":"string","description":"Detail information on status.","title":"Detail information on status"}}},"BackupSchedule":{"description":"Abstract base type for Weekly or Interval Backup Schedule","title":"Abstract base type for Weekly or Interval Backup Schedule","required":["resource_type"],"discriminator":"resource_type","x-vmw-nsx-module":"BackupConfiguration","type":"object","properties":{"resource_type":{"enum":["WeeklyBackupSchedule","IntervalBackupSchedule"],"type":"string","description":"Schedule type","title":"Schedule type"}}},"DhcpRelayServiceListResult":{"x-vmw-nsx-module":"DhcpRelay","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"DhcpRelay","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/DhcpRelayService"},"type":"array","description":"Dhcp relay service list results","title":"Dhcp relay service list results"}}}]},"LbVirtualServer":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"LoadBalancer","required":["application_profile_id","ip_address"],"type":"object","properties":{"access_list_control":{"$ref":"#/definitions/LbAccessListControl"},"ip_protocol":{"description":"Assigned Internet Protocol in IP header, TCP, UDP are supported.\n","default":"TCP","enum":["TCP","UDP"],"type":"string"},"log_significant_event_only":{"default":false,"type":"boolean","description":"The property log_significant_event_only can take effect only when\naccess_log_enabled is true. If log_significant_event_only is true,\nsignificant events are logged in access log.\nFor L4 virtual server, significant event means unsuccessful(error or\ndropped) TCP/UDP connections.\nFor L7 virtual server, significant event means unsuccessful connections\nor HTTP/HTTPS requests which have error response code(e.g. 4xx, 5xx).\n","title":"Log only significant event in access log"},"default_pool_member_ports":{"items":{"description":"Examples- Single port \"8080\", Range of ports \"8090-8095\"\n","format":"port-or-range","type":"string"},"type":"array","description":"If default_pool_member_ports are configured, both\ndefault_pool_member_port and default_pool_member_ports in the response\npayload would include port settings, notice that the value of\ndefault_pool_member_port is the first element of\ndefault_pool_member_ports.\n","maxItems":14,"title":"Default pool member ports when member port is not defined."},"persistence_profile_id":{"type":"string","description":"Persistence profile is used to allow related client connections to be\nsent to the same backend server.\n","title":"persistence profile identifier"},"server_ssl_profile_binding":{"$ref":"#/definitions/ServerSslProfileBinding"},"application_profile_id":{"type":"string","description":"The application profile defines the application protocol characteristics.\nIt is used to influence how load balancing is performed. Currently,\nLbFastTCPProfile, LbFastUDPProfile and\nLbHttpProfile, etc are supported.\n","title":"application profile identifier"},"pool_id":{"type":"string","description":"The server pool(LbPool) contains backend servers. Server pool\nconsists of one or more servers, also referred to as pool members, that\nare similarly configured and are running the same application.\n","title":"default server pool identifier"},"access_log_enabled":{"default":false,"type":"boolean","description":"Whether access log is enabled","title":"Whether access log is enabled"},"max_concurrent_connections":{"description":"To ensure one virtual server does not over consume resources,\naffecting other applications hosted on the same LBS, connections\nto a virtual server can be capped.\nIf it is not specified, it means that connections are unlimited.\nThe property is deprecated as NSX-T Load Balancer is deprecated.\n","title":"maximum concurrent connection number","format":"int64","maximum":2147483647,"x-deprecated":true,"minimum":1,"type":"integer"},"rule_ids":{"description":"Load balancer rules allow customization of load balancing behavior using\nmatch/action rules. Currently, load balancer rules are supported for\nonly layer 7 virtual servers with LbHttpProfile.\nThe property is deprecated as NSX-T Load Balancer is deprecated.\n","title":"List of load balancer rule identifiers","items":{"type":"string"},"x-deprecated":true,"maxItems":4000,"type":"array"},"max_new_connection_rate":{"description":"To ensure one virtual server does not over consume resources,\nconnections to a member can be rate limited.\nIf it is not specified, it means that connection rate is unlimited.\nThe property is deprecated as NSX-T Load Balancer is deprecated.\n","title":"maximum new connection rate in second","format":"int64","maximum":2147483647,"x-deprecated":true,"minimum":1,"type":"integer"},"sorry_pool_id":{"type":"string","description":"When load balancer can not select a backend server to serve the\nrequest in default pool or pool in rules, the request would be served\nby sorry server pool.\nThe property is deprecated as NSX-T Load Balancer is deprecated.\n","x-deprecated":true,"title":"Identifier of sorry server pool"},"client_ssl_profile_binding":{"$ref":"#/definitions/ClientSslProfileBinding"},"default_pool_member_port":{"description":"This is a deprecated property, please use 'default_pool_member_ports'\ninstead.\nIf default_pool_member_port is configured and default_pool_member_ports\nare not specified, both default_pool_member_port\nand default_pool_member_ports in response payload would return the same\nport value.\nIf both are specified, default_pool_member_ports setting would take\neffect with higher priority.\n","format":"port-or-range","x-deprecated":true,"type":"string"},"ip_address":{"description":"virtual server IP address","format":"ip","type":"string"},"port":{"description":"This is a deprecated property, please use 'ports' instead.\nPort setting could be single port for both L7 mode and L4 mode.\nFor L4 mode, a single port range is also supported.\nThe port setting could be a single port or port range such as\n\"80\", \"1234-1236\".\nIf port is configured and ports are not specified, both port and\nports in response payload would return the same port value.\nIf both port and ports are configured, ports setting would take effect\nwith higher priority.\n","format":"port-or-range","x-deprecated":true,"type":"string"},"enabled":{"default":true,"type":"boolean","description":"whether the virtual server is enabled","title":"whether the virtual server is enabled"},"ports":{"items":{"description":"Examples- Single port \"8080\", Range of ports \"8090-8095\"\n","format":"port-or-range","type":"string"},"type":"array","description":"Port setting could be a single port for both L7 mode and L4 mode.\nFor L4 mode, multiple ports or port ranges are also supported such\nas \"80\", \"443\", \"1234-1236\".\nIf ports is configured, both port and ports in the response payload\nwould include port settings, notice that the port field value is the\nfirst element of ports.\n","maxItems":14,"title":"Virtual server ports or port ranges"}}}]},"FirewallSectionsSummary":{"x-vmw-nsx-module":"FirewallSummary","allOf":[{"$ref":"#/definitions/Resource"},{"x-vmw-nsx-module":"FirewallSummary","type":"object","properties":{"section_count":{"readOnly":true,"format":"int64","type":"integer","description":"Total number of sections for the section type.","title":"Section count"},"rule_count":{"readOnly":true,"format":"int64","type":"integer","description":"Total number of rules in the section.","title":"Rule count"},"section_type":{"description":"Type of rules which a section can contain.","enum":["L2DFW","L3DFW","L3BRIDGEPORTFW","L3LOGICALROUTERFW"],"readOnly":true,"type":"string"}}}]},"OperationCollectorGlobalConfig":{"x-vmw-nsx-module":"GlobalConfigs","allOf":[{"$ref":"#/definitions/GlobalConfigs"},{"x-vmw-nsx-module":"GlobalConfigs","type":"object","properties":{"report_interval":{"description":"Report interval for operation data in seconds.","title":"Report interval for operation data in seconds","default":30,"format":"int32","maximum":1800,"minimum":1,"type":"integer"},"collectors":{"items":{"$ref":"#/definitions/OperationCollector"},"type":"array","description":"Operation Collector Config.","title":"Operation Collector Config"}}}],"description":"NSX global configs for operation collector","title":"NSX global configs for operation collector"},"LogicalConstructMigrationStatsListResult":{"x-vmw-nsx-module":"Migration","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"Migration","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/LogicalConstructMigrationStats"},"readOnly":true,"type":"array","description":"Paged collection of migration stats for logical constructs","title":"Paged collection of migration stats for logical constructs"}}}]},"MacPoolListResult":{"x-vmw-nsx-module":"MACAM","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"MACAM","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/MacPool"},"type":"array","description":"MAC pool list results","title":"MAC pool list results"}}}]},"SIDataCounter":{"x-vmw-nsx-module":"ServiceInsertionVMDeployment","required":["total"],"type":"object","properties":{"total":{"format":"int64","type":"integer","description":"The total packets or bytes","title":"The total packets or bytes"},"multicast_broadcast":{"format":"int64","type":"integer","description":"The multicast and broadcast packets or bytes","title":"The multicast and broadcast packets or bytes"},"dropped":{"format":"int64","type":"integer","description":"The dropped packets or bytes","title":"The dropped packets or bytes"}}},"TransportZoneListResult":{"x-vmw-nsx-module":"TransportZone","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"TransportZone","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/TransportZone"},"type":"array","description":"Transport Zone Results","title":"Transport Zone Results"}}}],"description":"Transport zone queries result","title":"Transport zone queries result"},"LbHttpProfile":{"x-vmw-nsx-module":"LoadBalancer","description":"The object is deprecated as NSX-T Load Balancer is deprecated.\n","allOf":[{"$ref":"#/definitions/LbAppProfile"},{"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"response_buffering":{"default":false,"type":"boolean","description":"When buffering is disabled, the response is passed to a client\nsynchronously, immediately as it is received.\nWhen buffering is enabled, LB receives a response from the backend\nserver as soon as possible, saving it into the buffers.\n","title":"Enable or disable buffering of responses"},"response_timeout":{"description":"If server doesn't send any packet within this time, the connection is closed.\n","title":"Maximum server idle time in seconds","default":60,"format":"int64","maximum":2147483647,"minimum":1,"type":"integer"},"request_body_size":{"description":"If it is not specified, it means that request body size is unlimited.\n","format":"int64","title":"Maximum size of the buffer used to store HTTP request body","maximum":2147483647,"minimum":1,"type":"integer"},"ntlm":{"type":"boolean","description":"NTLM is an authentication protocol that can be used over HTTP. If the\nflag is set to true, LB will use NTLM challenge/response methodology.\nThis property is deprecated. Please use the property server_keep_alive\nin order to keep the backend server connection alive for the client\nconnection.\nWhen create a new profile, if both ntlm and server_keep_alive are set\nas different values, ERROR will be reported.\nWhen update an existing profile, if either ntlm or server_keep_alive\nvalue is changed, both of them are updated with the changed value.\n","x-deprecated":true,"title":"NTLM support flag"},"request_header_size":{"description":"A request with header equal to or below this size is guaranteed to be\nprocessed. A request with header larger than request_header_size will\nbe processed up to 32K bytes on best effort basis.\n","format":"int64","default":1024,"title":"Maximum size of the buffer used to store HTTP request headers","minimum":1,"type":"integer"},"http_redirect_to_https":{"default":false,"type":"boolean","description":"Certain secure applications may want to force communication over SSL,\nbut instead of rejecting non-SSL connections, they may choose to\nredirect the client automatically to use SSL.\n","title":"flag to indicate whether enable HTTP-HTTPS redirect"},"response_header_size":{"description":"A response with header larger than response_header_size will be dropped.\n","title":"Maximum size of the buffer used to store HTTP response headers","default":4096,"format":"int64","maximum":65536,"minimum":1,"type":"integer"},"idle_timeout":{"description":"It is used to specify the HTTP application idle timeout, it means that\nhow long the load balancer will keep the connection idle to wait for\nthe client to send the next keep-alive request. It is not a TCP socket\nsetting.\n","title":"HTTP application idle timeout in seconds","default":15,"format":"int64","maximum":5400,"minimum":1,"type":"integer"},"server_keep_alive":{"type":"boolean","description":"If server_keep_alive is true, it means the backend connection will keep\nalive for the client connection. Every client connection is tied 1:1\nwith the corresponding server-side connection.\nIf server_keep_alive is false, it means the backend connection won't\nkeep alive for the client connection. The default value is false.\nIf server_keep_alive is not specified for API input, its value in API\noutput will be the same with the property ntlm.\n","title":"Server keep-alive flag"},"http_redirect_to":{"type":"string","description":"If a website is temporarily down or has moved, incoming requests\nfor that virtual server can be temporarily redirected to a URL\n","title":"http redirect static URL"},"x_forwarded_for":{"description":"When X-Forwareded-For is configured, X-Forwarded-Proto and\nX-Forwarded-Port information is added automatically. The two additional\nheader information can be also modified or deleted in load balancer\nrules.\n","enum":["INSERT","REPLACE"],"type":"string"}}}]},"ServiceInsertionRuleListResult":{"x-vmw-nsx-module":"ServiceInsertionRules","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"ServiceInsertionRules","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/ServiceInsertionRule"},"readOnly":true,"type":"array","description":"ServiceInsertion rule list result with pagination support.","title":"ServiceInsertion rule list result"}}}],"description":"List of ServiceInsertion Rules.","title":"ServiceInsertion Section RuleList"},"ServiceInsertionSectionRuleList":{"x-vmw-nsx-module":"ServiceInsertionRules","allOf":[{"$ref":"#/definitions/ServiceInsertionSection"},{"required":["rules"],"x-vmw-nsx-module":"ServiceInsertionRules","type":"object","properties":{"rules":{"description":"List of Service Insertion rules in the section. Only homogeneous rules are supported.","title":"List of the Service Insertion rules","items":{"$ref":"#/definitions/ServiceInsertionRule"},"readOnly":false,"maxItems":1000,"type":"array"}}}],"description":"List of ServiceInsertion Rules.","title":"ServiceInsertion Section RuleList"},"TrunkVlanRange":{"description":"Trunk VLAN id range","title":"Trunk VLAN id range","required":["start","end"],"x-vmw-nsx-module":"LogicalSwitch","type":"object","properties":{"start":{"type":"integer","description":"Virtual Local Area Network Identifier","format":"int64"},"end":{"type":"integer","description":"Virtual Local Area Network Identifier","format":"int64"}}},"MigrationUnitTypeStatsList":{"x-vmw-nsx-module":"Migration","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"Migration","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/MigrationUnitTypeStats"},"readOnly":true,"type":"array","description":"List of migration unit type stats","title":"List of migration unit type stats"}}}]},"LbIpHeaderCondition":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/LbRuleCondition"},{"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"group_id":{"type":"string","description":"Source IP address of HTTP message should match IP addresses which are\nconfigured in Group in order to perform actions.\n","title":"Grouping object identifier"},"source_address":{"description":"Source IP address of HTTP message. IP Address can be expressed as a\nsingle IP address like 10.1.1.1, or a range of IP addresses like\n10.1.1.101-10.1.1.160. Both IPv4 and IPv6 addresses are supported.\n","format":"address-or-block-or-range","type":"string"}}}],"description":"This condition is used to match IP header fields of HTTP messages.\nEither source_address or group_id should be specified.\n","title":"Condition to match IP header fields"},"ServiceProfileNSGroups":{"x-vmw-nsx-module":"ServiceInsertionCommonTypes","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"ServiceInsertionCommonTypes","type":"object","properties":{"nsroups":{"items":{"$ref":"#/definitions/NSGroupInfo"},"readOnly":true,"type":"array","description":"List of NSGroups Used in ServiceInsertion Rules.","title":"NSGroup List"}}}],"description":"ServiceProfileNSGroups contains list of NS Groups referenced in Service Insertion Rules. To be considered, Service profile must be part of a Service Chain and that Service chain must be used in a Rule.","title":"NSGroups used in Service Profile"},"UpgradeHistoryList":{"x-vmw-nsx-module":"UpgradeTypes","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"UpgradeTypes","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/UpgradeHistory"},"readOnly":true,"type":"array","description":"Upgrade history list","title":"Upgrade history list"}}}]},"SetPrincipalIdentityCertificateForFederationRequest":{"x-vmw-nsx-module":"CertificateManager","type":"object","description":"Data for setting a principal identity certificate","properties":{"service_type":{"description":"Service type for which the certificate should be used.","enum":["LOCAL_MANAGER","GLOBAL_MANAGER"],"readOnly":true,"type":"string"},"cert_id":{"readOnly":true,"type":"string","description":"Id of the certificate"}},"title":"Data for setting a principal identity certificate"},"IpBlock":{"x-vmw-nsx-module":"Ipam","description":"A block of IPv4/IPv6 addresses defined by a start address and a mask/prefix (network CIDR). An IP block is typically large & allocated to a tenant for automated consumption. An IP block is always a contiguous address space, for example 192.0.0.1/8. An IP block can be further subdivided into subnets called IP block subnets. These IP block subnets can later be added to IP pools and used for IP allocation. An IP pool is typically a collection of subnets that are often not a contiguous address space. Clients are allocated IP addresses only from IP pools. Sample Structure Diagram IpBlock_VMware 192.0.0.1/8 ======================================================================= / ___________________________________________/________ / IpBlockSubnet_Finance ( IpBlockSubnet_Eng1 IpBlockSubnet_Eng2 / ) / 192.168.0.1/16 ( 192.170.1.1/16 192.180.1.1/24 / ) IpPool_Eng / (___________________________________________/________) / / =======================================================================","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"Ipam","required":["cidr"],"type":"object","properties":{"cidr":{"format":"ip-cidr-block","type":"string","description":"Represents network address and the prefix length which will be associated with a layer-2 broadcast domain","title":"Represents network address and the prefix length which will be associated with a layer-2 broadcast domain"}}}]},"IpfixCollectorUpmProfile":{"x-vmw-nsx-module":"UpmIpfixCollector","allOf":[{"$ref":"#/definitions/ManagedResource"},{"required":["resource_type","collectors"],"x-vmw-nsx-module":"UpmIpfixCollector","type":"object","properties":{"resource_type":{"description":"All IPFIX collector profile types.","enum":["IpfixCollectorUpmProfile"],"readOnly":false,"type":"string"},"collectors":{"description":"IPFIX Collector Set","title":"IPFIX Collector Set","minItems":1,"items":{"$ref":"#/definitions/IpfixCollector"},"maxItems":4,"type":"array"}}}],"description":"The configuration for Internet protocol flow information export (IPFIX)\ncollector. It should be referenced in other IPFIX profile as a collecor\nconfig. The IPFIX exporter will send records to these collectors.\n","title":"IPFIX Collector Profile"},"L2VPNTransportTunnelStatus":{"description":"Transport tunnel status.","title":"Transport tunnel status","required":["resource_type"],"discriminator":"resource_type","x-vmw-nsx-module":"L2VPNStatistics","type":"object","properties":{"resource_type":{"description":"Resource types of L2VPN Transport tunnels","enum":["IPSecVPNTransportStatus"],"type":"string"},"tunnel_id":{"$ref":"#/definitions/ResourceReference"}}},"SystemHealthAgentProfileListResult":{"x-vmw-nsx-module":"SystemHealthAgent","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"SystemHealthAgent","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/SystemHealthAgentProfile"},"readOnly":true,"type":"array","description":"System Health Profile List","title":"System Health Profile List"}}}],"description":"The list result for query of system health profile entity.","title":"List of System Health Profiles"},"CurrentRealizationStateBarrier":{"x-vmw-nsx-module":"RealizationStateBarrier","type":"object","description":"The current global barrier number of the realized state","properties":{"current_barrier_number":{"readOnly":true,"type":"integer","description":"Gives the current global barrier number for NSX","format":"int64"}}},"ContainerIngressPolicy":{"x-vmw-nsx-module":"InventoryContainerObj","allOf":[{"$ref":"#/definitions/DiscoveredResource"},{"required":["external_id"],"x-vmw-nsx-module":"InventoryContainerObj","type":"object","properties":{"network_status":{"readOnly":false,"enum":["HEALTHY","UNHEALTHY"],"type":"string","description":"Network status of container ingress.","title":"Network status of container ingress"},"container_cluster_id":{"readOnly":false,"type":"string","description":"Identifier of the container cluster this ingress policy belongs to.","title":"Identifier of the container cluster"},"container_application_ids":{"items":{"type":"string"},"readOnly":false,"type":"array","description":"List of identifiers of the container application , on which ingress policy\nis applied. e.g. IDs of all services on which the ingress is applied in\nkubernetes.\n","title":"Identifiers of the container application"},"origin_properties":{"items":{"$ref":"#/definitions/KeyValuePair"},"readOnly":false,"type":"array","description":"Array of additional specific properties of container ingress\nin key-value format.\n","title":"Origin properties"},"external_id":{"readOnly":false,"type":"string","description":"Identifier of the container ingress policy.","title":"External identifier of the container ingress policy"},"container_project_id":{"readOnly":false,"type":"string","description":"Identifier of the project which this container ingress belongs to.","title":"Identifier of the project"},"network_errors":{"items":{"$ref":"#/definitions/NetworkError"},"readOnly":false,"type":"array","description":"List of network errors related to container ingress.","title":"Network errors"},"spec":{"readOnly":false,"type":"string","description":"Container ingress policy specification.","title":"Container ingress policy specification"}}}],"description":"Details of Container Ingress Policy.","title":"Container Ingress Policy"},"MACSetListResult":{"x-vmw-nsx-module":"MACSet","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"MACSet","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/MACSet"},"type":"array","description":"Paged collection of MACSets","title":"Paged collection of MACSets"}}}]},"IPv4AddressProperties":{"x-vmw-nsx-module":"MISSING_MODULE","type":"object","description":"IPv4 address properties","properties":{"netmask":{"type":"string","description":"Interface netmask","title":"Interface netmask"},"ip_address":{"type":"string","description":"Interface IPv4 address","title":"Interface IPv4 address"}},"title":"IPv4 address properties"},"LbServiceStatistics":{"x-vmw-nsx-module":"AggSvcLb","required":["service_id"],"type":"object","properties":{"pools":{"items":{"$ref":"#/definitions/LbPoolStatistics"},"type":"array","description":"Statistics of load balancer pools","title":"Statistics of load balancer pools"},"service_id":{"type":"string","description":"load balancer service identifier","title":"load balancer service identifier"},"virtual_servers":{"items":{"$ref":"#/definitions/LbVirtualServerStatistics"},"type":"array","description":"Statistics of load balancer virtual servers","title":"Statistics of load balancer virtual servers"},"last_update_timestamp":{"type":"integer","description":"Timestamp when the data was last updated","format":"int64"},"statistics":{"$ref":"#/definitions/LbServiceStatisticsCounter"}}},"TraceflowObservationReplicationLogical":{"x-vmw-nsx-module":"Traceflow","allOf":[{"$ref":"#/definitions/TraceflowObservation"},{"x-vmw-nsx-module":"Traceflow","type":"object","properties":{"vtep_label":{"readOnly":true,"format":"int64","type":"integer","description":"The label of VTEP","title":"The label of VTEP"},"replication_type":{"readOnly":true,"enum":["TX_VTEP","TX_MTEP","RX"],"type":"string","description":"This field specifies the type of replication message TX_VTEP - Transmit replication to all VTEPs TX_MTEP - Transmit replication to all MTEPs RX - Receive replication","title":"The replication type of the message"},"local_ip_address":{"description":"Local IP address of the component that replicates the packet.","format":"ip","readOnly":true,"type":"string"},"uplink_name":{"readOnly":true,"type":"string","description":"The name of uplink","title":"The name of uplink"}}}]},"NodeSshServiceProperties":{"x-vmw-nsx-module":"MISSING_MODULE","allOf":[{"$ref":"#/definitions/NodeServiceProperties"},{"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"service_properties":{"$ref":"#/definitions/SshServiceProperties"}}}],"description":"Node SSH service properties","title":"Node SSH service properties"},"TargetResourceStatus":{"x-vmw-nsx-module":"FirewallStatus","required":["target_status"],"type":"object","description":"Holds status of target resource in firewall context.","properties":{"target_status":{"description":"Firewall status on a target logical resource.","enum":["DISABLED","ENABLED"],"readOnly":false,"type":"string"},"target_id":{"readOnly":false,"maxLength":64,"type":"string","description":"Identifier of the NSX resource.","title":"Target ID"}}},"NodeProtonServiceProperties":{"x-vmw-nsx-module":"MISSING_MODULE","allOf":[{"$ref":"#/definitions/NodeServiceProperties"},{"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"service_properties":{"$ref":"#/definitions/LoggingServiceProperties"}}}],"description":"Node service properties","title":"Node service properties"},"PolicyTraceflowObservationRelayedLogical":{"x-vmw-nsx-module":"PolicyConnectivity","allOf":[{"$ref":"#/definitions/TraceflowObservationRelayedLogical"},{"x-vmw-nsx-module":"PolicyConnectivity","type":"object","properties":{"logical_component_path":{"readOnly":true,"type":"string","description":"This field specifies the logical component that relay service located on.","title":"The path of the component on which relay service located"}}}]},"MacRange":{"x-vmw-nsx-module":"MACAM","required":["start","end"],"type":"object","description":"A range of MAC addresses with a start and end value","properties":{"start":{"description":"Start value for MAC address range","format":"mac-address","readOnly":false,"type":"string"},"end":{"description":"End value for MAC address range","format":"mac-address","readOnly":false,"type":"string"}}},"DirectoryDomainSyncStats":{"x-vmw-nsx-module":"DirectoryService","type":"object","description":"Directory domain synchronization statistics","properties":{"prev_sync_status":{"readOnly":true,"enum":["SUCCESS","FAILURE","UNKNOWN"],"type":"string","description":"Directory domain previous sync status. It could be one of the following two states.","title":"Previous sync status"},"avg_full_sync_time":{"readOnly":true,"format":"int64","type":"integer","description":"All the historical full sync are counted in calculating the average full sync time in milliseconds.","title":"Average time spent for all historical full sync"},"prev_sync_type":{"readOnly":true,"enum":["IDLE","FULL_SYNC","DELTA_SYNC","SELECTIVE_FULL_SYNC","SELECTIVE_DELTA_SYNC"],"type":"string","description":"Directory domain previous sync type. It could be one of the following five states. Right after the directory domain is configured, this field is set to IDLE.","title":"Previous sync type"},"num_full_sync":{"readOnly":true,"format":"int64","type":"integer","description":"number of successful historical full sync initiated either by system or by API request.","title":"Total number of successful full sync"},"current_state_begin_time":{"description":"Since what time the current state has begun. The time is expressed in millisecond epoch time.","format":"int64","readOnly":true,"type":"integer"},"avg_delta_sync_time":{"readOnly":true,"format":"int64","type":"integer","description":"All the historical delta sync are counted in calculating the average delta sync time in milliseconds.","title":"Average time spent for all historical delta sync"},"prev_sync_error":{"readOnly":true,"type":"string","description":"Directory domain previous sync status error if last status was failure.","title":"Previous sync error"},"current_state":{"readOnly":true,"enum":["IDLE","FULL_SYNC","DELTA_SYNC","SELECTIVE_FULL_SYNC","SELECTIVE_DELTA_SYNC"],"type":"string","description":"Current running state of the directory domain in synchronization life cycle. It could be one of the following five states. SELECTIVE_FULL_SYNC and SELECTIVE_DELTA_SYNC are sync states for selective sync.","title":"Current state of directory domain sync context"},"num_delta_sync":{"readOnly":true,"format":"int64","type":"integer","description":"number of successful historical delta sync initiated either by system or by API request.","title":"Total number of successful delta sync"},"prev_sync_end_time":{"description":"Directory domain previous sync ending time expressed in millisecond epoch time.","format":"int64","readOnly":true,"type":"integer"}},"title":"Directory domain synchronization statistics"},"IpPool":{"x-vmw-nsx-module":"Ipam","description":"A collection of one or more IPv4 or IPv6 subnets or ranges that are often not a contiguous address space. Clients are allocated IPs from an IP pool. Often used when a client that consumes addresses exhausts an initial subnet or range and needs to be expanded but the adjoining address space is not available as it has been allocated to a different client.","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"Ipam","type":"object","properties":{"check_overlap_with_existing_pools":{"default":false,"type":"boolean","description":"If true, a validation error will be thrown if another IP pool is found to be overlapping with this pool.\nThe flag is false by default.\n","title":"Specifies whether to perform overlap check with existing IP pools"},"subnets":{"items":{"$ref":"#/definitions/IpPoolSubnet"},"type":"array","description":"Subnets can be IPv4 or IPv6 and they should not overlap. The maximum number will not exceed 5 subnets.","maxItems":5,"title":"The collection of one or more subnet objects in a pool"},"pool_usage":{"$ref":"#/definitions/PoolUsage"},"ip_release_delay":{"format":"int64","type":"integer","description":"Delay in milliseconds, while releasing allocated IP address from IP pool (Default is 2 mins).","title":"IP address release delay in milliseconds"}}}]},"DropdownFilterWidgetConfiguration":{"x-vmw-nsx-module":"NsxDashboard","allOf":[{"$ref":"#/definitions/FilterWidgetConfiguration"},{"x-vmw-nsx-module":"NsxDashboard","type":"object","properties":{"default_value":{"type":"string","description":"Expression to specify default value of filter.","title":"Expression to specify default value"},"dropdown_filter_plot_config":{"$ref":"#/definitions/DropdownFilterPlotConfiguration"},"placeholder_msg":{"type":"string","description":"Placeholder message to be displayed in dropdown filter.","title":"Placeholder message to be shown in filter"},"static_filters":{"items":{"$ref":"#/definitions/StaticFilter"},"type":"array","description":"Additional static items to be added in dropdown filter. Example can be 'ALL'.","title":"Additional static items to be added in dropdown filter"},"dropdown_item":{"$ref":"#/definitions/DropdownItem"},"static_filter_condition":{"type":"string","description":"If the condition is met then the static filter will be added. If no condition is provided, then the static filters will be applied unconditionally.","title":"Expression for evaluating condition"}}}],"description":"Represents configuration for dropdown filter widget.","title":"Dropdown Filter widget Configuration"},"MACSet":{"x-vmw-nsx-module":"MACSet","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"MACSet","type":"object","properties":{"mac_addresses":{"items":{"description":"A MAC address. Must be 6 pairs of hexadecimal digits, upper or lower case,\nseparated by colons or dashes. Examples: 01:23:45:67:89:ab, 01-23-45-67-89-AB.\n","format":"mac-address","type":"string"},"type":"array","description":"MAC addresses","maxItems":4000,"title":"MAC addresses"}}}],"description":"MACSet is used to group individual MAC addresses. MACSets can be used as\nsources and destinations in layer2 firewall rules. These can also be used as\nmembers of NSGroups.\n","title":"Set of one or more MAC addresses"},"IcmpEchoRequestHeader":{"x-vmw-nsx-module":"Traceflow","type":"object","properties":{"id":{"description":"ICMP id","title":"ICMP id","default":0,"format":"int64","maximum":65535,"minimum":0,"type":"integer"},"sequence":{"description":"ICMP sequence number","title":"ICMP sequence number","default":0,"format":"int64","maximum":65535,"minimum":0,"type":"integer"}}},"FirewallRule":{"x-vmw-nsx-module":"Firewall","allOf":[{"$ref":"#/definitions/DSRule"},{"x-vmw-nsx-module":"Firewall","type":"object","properties":{"services":{"description":"List of the services. Null will be treated as any.","title":"Service List","items":{"$ref":"#/definitions/FirewallService"},"readOnly":false,"maxItems":128,"type":"array"},"context_profiles":{"items":{"$ref":"#/definitions/ResourceReference"},"type":"array","description":"NS Profile object which accepts attributes and sub-attributes of various network services (ex. L7 AppId, domain name, encryption algorithm) as key value pairs.","maxItems":128,"title":"Context Profiles"},"extended_sources":{"items":{"$ref":"#/definitions/ResourceReference"},"type":"array","description":"List of NSGroups that have end point attributes like AD Groups(SID), process name, process hash etc. For Flash release, only NSGroups containing AD Groups are supported.","maxItems":128,"title":"Extended Sources"},"section_id":{"readOnly":true,"type":"string","description":"Section Id of the section to which this rule belongs to.","title":"Section Id"}}}]},"IdsVmList":{"x-vmw-nsx-module":"IDSMetrics","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"IDSMetrics","type":"object","properties":{"results":{"items":{"type":"string"},"readOnly":true,"type":"array","description":"List of all affected VMs specific to a particular signature.","title":"List of all affected VMs"}}}],"description":"List of all affected VMs pertaining to a\nspecific signature.\n","title":"List of affected VMs"},"ContainerApplicationInstanceListResult":{"x-vmw-nsx-module":"InventoryContainerObj","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"InventoryContainerObj","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/ContainerApplicationInstance"},"type":"array","description":"List of Container Applications","title":"List of Container Applications"}}}]},"PrincipalIdentity":{"x-vmw-nsx-module":"CertificateManager","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"CertificateManager","required":["node_id","name"],"type":"object","properties":{"certificate_id":{"readOnly":false,"type":"string","description":"Id of the stored certificate. When used with the deprecated POST /trust-management/principal-identities API this field is required.","title":"Id of the stored certificate"},"is_protected":{"readOnly":false,"type":"boolean","description":"Indicator whether the entities created by this principal should be protected.","title":"Protection indicator"},"role":{"readOnly":false,"type":"string","description":"The roles that are associated with this PI.","title":"Role"},"name":{"readOnly":false,"maxLength":255,"type":"string","description":"Name of the principal.","title":"Name"},"node_id":{"readOnly":false,"maxLength":255,"type":"string","description":"Unique node-id of a principal. This is used primarily in the case\nwhere a cluster of nodes is used to make calls to the NSX Manager and\nthe same 'name' is used so that the nodes can access and modify the\nsame data while still accessing NSX through their individual secret\n(certificate or JWT). In all other cases this can be any string.\n","title":"Unique node-id"}}}]},"RemoteFileServer":{"description":"Remote file server","title":"Remote file server","required":["directory_path","protocol","server"],"x-vmw-nsx-module":"BackupConfiguration","type":"object","properties":{"directory_path":{"type":"string","description":"Remote server directory to copy bundle files to","title":"Remote server directory to copy bundle files to"},"protocol":{"$ref":"#/definitions/FileTransferProtocol"},"port":{"description":"Server port","title":"Server port","default":22,"format":"int64","maximum":65535,"minimum":1,"type":"integer"},"server":{"format":"hostname-or-ip","type":"string","description":"Remote server hostname or IP address","title":"Remote server hostname or IP address"}}},"HostSwitchSpec":{"description":"The HostSwitchSpec is the base class for standard and preconfigured\nhost switch specifications.\n","title":"Abstract base type for transport node host switch specification","required":["resource_type"],"discriminator":"resource_type","x-vmw-nsx-module":"TransportNode","type":"object","properties":{"resource_type":{"enum":["StandardHostSwitchSpec","PreconfiguredHostSwitchSpec"],"type":"string"}}},"UpgradeUnitListResult":{"x-vmw-nsx-module":"Upgrade","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"Upgrade","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/UpgradeUnit"},"type":"array","description":"Paged Collection of Upgrade units","title":"Paged Collection of Upgrade units"}}}]},"LbPoolStatus":{"x-vmw-nsx-module":"AggSvcLb","required":["pool_id"],"type":"object","properties":{"status":{"enum":["UP","PARTIALLY_UP","PRIMARY_DOWN","DOWN","DETACHED","UNKNOWN"],"type":"string","description":"UP means that all primary members are in UP status.\nPARTIALLY_UP means that some(not all) primary members are in UP\nstatus, the number of these active members is larger or equal to\ncertain number(min_active_members) which is defined in LbPool.\nWhen there are no backup members which are in the UP status, the\nnumber(min_active_members) would be ignored.\nPRIMARY_DOWN means that less than certain(min_active_members) primary\nmembers are in UP status but backup members are in UP status,\nconnections to this pool would be dispatched to backup members.\nDOWN means that all primary and backup members are DOWN.\nDETACHED means that the pool is not bound to any virtual server.\nUNKNOWN means that the pool is not associated to any enabled virtual\nservers, or no status reported from transport-nodes, the associated\nload balancer service may be working(or not working).\n","title":"Virtual server status"},"last_update_timestamp":{"type":"integer","description":"Timestamp when the data was last updated","format":"int64"},"pool_id":{"type":"string","description":"Load balancer pool identifier","title":"Load balancer pool identifier"},"members":{"items":{"$ref":"#/definitions/LbPoolMemberStatus"},"type":"array","description":"Status of load balancer pool members","title":"Status of load balancer pool members"}}},"CrlDistributionPoint":{"x-vmw-nsx-module":"CertificateManager","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"CertificateManager","type":"object","properties":{"cdp_uri":{"readOnly":true,"maxLength":255,"type":"string","description":"CRL Distribution Point URI where to fetch the CRL.","title":"CDP URI"},"issuer":{"readOnly":true,"maxLength":255,"type":"string","description":"Issuer of the CRL, referring to the CA.","title":"Issuer"}}}],"description":"Reference to a CRL Distribution Point where to fetch a CRL","title":"Reference to a CRL Distribution Point where to fetch a CRL"},"SelfResourceLink":{"x-vmw-nsx-module":"Common","allOf":[{"$ref":"#/definitions/ResourceLink"},{"x-vmw-nsx-module":"Common","type":"object"}],"description":"The server will populate this field when returing the resource. Ignored on PUT and POST.","title":"Link to this resource"},"AddManagementNodeSpec":{"x-vmw-nsx-module":"ClusterManagement","required":["type","user_name","remote_address"],"type":"object","properties":{"mpa_msg_client_info":{"$ref":"#/definitions/MsgClientInfo"},"type":{"readOnly":false,"enum":["AddManagementNodeSpec"],"type":"string","description":"must be set to AddManagementNodeSpec","title":"must be set to AddManagementNodeSpec"},"password":{"readOnly":false,"type":"string","description":"The password to be used to authenticate with the remote node.","title":"The password to be used to authenticate with the remote node."},"user_name":{"readOnly":false,"type":"string","description":"The username to be used to authenticate with the remote node.","title":"The username to be used to authenticate with the remote node."},"remote_address":{"description":"The host address of the remote node to which to send this join request.","format":"ip","readOnly":false,"type":"string"},"cert_thumbprint":{"readOnly":false,"type":"string","description":"The certificate thumbprint of the remote node.","title":"The certificate thumbprint of the remote node."}}},"EdgeHighAvailabilityProfile":{"x-vmw-nsx-module":"EdgeHighAvailabilityProfile","allOf":[{"$ref":"#/definitions/ClusterProfile"},{"x-vmw-nsx-module":"EdgeHighAvailabilityProfile","type":"object","properties":{"standby_relocation_config":{"$ref":"#/definitions/StandbyRelocationConfig"},"bfd_declare_dead_multiple":{"description":"Number of times a packet is missed before BFD declares the neighbor down.","title":"Number of times a packet is missed before BFD declares the neighbor down.","default":3,"format":"int64","maximum":16,"minimum":2,"type":"integer"},"bfd_probe_interval":{"description":"the time interval (in millisec) between probe packets for heartbeat purpose","title":"the time interval (in millisec) between probe packets for heartbeat purpose","default":500,"format":"int64","maximum":60000,"minimum":50,"type":"integer"},"bfd_allowed_hops":{"description":"BFD allowed hops","title":"BFD allowed hops","default":255,"format":"int64","maximum":255,"minimum":1,"type":"integer"}}}],"description":"Profile for BFD HA cluster setting","title":"Profile for BFD HA cluster setting"},"IdfwNsgroupVmDetailListResult":{"x-vmw-nsx-module":"IdentityFirewall","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"IdentityFirewall","type":"object","properties":{"ns_group_id":{"readOnly":true,"type":"string","description":"NSGroup ID","title":"NSGroup ID"},"results":{"items":{"$ref":"#/definitions/IdfwVmDetail"},"type":"array","description":"List of user login/session data for a single VM","title":"List of user login/session data for a single VM"}}}],"description":"Identity Firewall user login/session data for a single NSGroup.","title":"Identity Firewall user login/session data for a single NSGroup"},"RenderConfiguration":{"x-vmw-nsx-module":"NsxDashboard","type":"object","description":"Render configuration to be applied to the widget.","properties":{"color":{"type":"string","description":"The color to use when rendering an entity. For example, set color as 'RED' to render a portion of donut in red.","title":"Color of the entity"},"condition":{"maxLength":1024,"type":"string","description":"If the condition is met then the rendering specified for the condition will be applied. Examples of expression syntax are provided under 'example_request' section of 'CreateWidgetConfiguration' API.","title":"Expression for evaluating condition"},"display_value":{"maxLength":255,"type":"string","description":"If specified, overrides the field value. This can be used to display a meaningful value in situations where field value is not available or not configured.","title":"Overridden value to display, if any"},"tooltip":{"minItems":0,"items":{"$ref":"#/definitions/Tooltip"},"type":"array","description":"Multi-line text to be shown on tooltip while hovering over the UI element if the condition is met.","title":"Multi-line tooltip"},"icons":{"minItems":0,"items":{"$ref":"#/definitions/Icon"},"type":"array","description":"Icons to be applied at dashboard for widgets and UI elements.","title":"Icons"}},"title":"Render Configuration"},"PortConnectionEntity":{"x-vmw-nsx-module":"PortConnection","type":"object","description":"Port Connection Entity","properties":{"resource":{"$ref":"#/definitions/ManagedResource"},"id":{"readOnly":true,"type":"string","description":"Resource ID is mapped to this. (ID is Generated for Edge node groups, since resource will be null)","title":"Resource ID is mapped to this. (ID is Generated for Edge node groups, since resource will be null)"}},"title":"Port Connection Entity"},"HealthCheckVlanRange":{"description":"VLAN ID range","title":"VLAN ID range","required":["start","end"],"x-vmw-nsx-module":"HealthCheck","type":"object","properties":{"start":{"type":"integer","description":"Virtual Local Area Network Identifier","format":"int64"},"end":{"type":"integer","description":"Virtual Local Area Network Identifier","format":"int64"}}},"PerUpstreamServerStatistics":{"x-vmw-nsx-module":"AggSvcDnsForwarder","type":"object","description":"Query statistics counters to an upstream server including successfully\nforwarded queries and failed queries.\n","properties":{"queries_failed":{"readOnly":true,"format":"int64","type":"integer","description":"Queries failed to forward.","title":"Queries failed to forward."},"upstream_server":{"description":"Upstream server ip","format":"ip","readOnly":true,"type":"string"},"queries_succeeded":{"readOnly":true,"format":"int64","type":"integer","description":"Queries forwarded successfully","title":"Queries forwarded successfully"}},"title":"Per-upstream server query statistics counters"},"MigrationUnitStatus":{"x-vmw-nsx-module":"Migration","type":"object","properties":{"status":{"readOnly":true,"enum":["SUCCESS","FAILED","IN_PROGRESS","NOT_STARTED","PAUSING","PAUSED"],"type":"string","description":"Status of migration unit","title":"Status of migration unit"},"errors":{"items":{"type":"string"},"readOnly":true,"type":"array","description":"List of errors occurred during migration of this migration unit","title":"List of errors occurred during migration of this migration unit"},"display_name":{"readOnly":true,"type":"string","description":"Name of migration unit","title":"Name of migration unit"},"id":{"readOnly":true,"type":"string","description":"Identifier of migration unit","title":"UUID of migration unit"},"percent_complete":{"readOnly":true,"type":"number","description":"Indicator of migration progress in percentage","title":"Indicator of migration progress in percentage"}}},"NSGroupExpression":{"description":"Policy expression for NSGroup membership","title":"Policy expression for NSGroup membership","required":["resource_type"],"discriminator":"resource_type","x-vmw-nsx-module":"NSGroup","type":"object","properties":{"resource_type":{"enum":["NSGroupSimpleExpression","NSGroupComplexExpression","NSGroupTagExpression"],"type":"string"}}},"RuleState":{"x-vmw-nsx-module":"Firewall","allOf":[{"$ref":"#/definitions/DSRuleState"},{"x-vmw-nsx-module":"Firewall","type":"object","properties":{"pending_change_list":{"items":{"$ref":"#/definitions/PendingChange"},"type":"array","description":"Pending changes to be realized.","maxItems":100,"title":"List of pending changes"}}}]},"BfdConfigParameters":{"x-vmw-nsx-module":"Routing","type":"object","description":"BFD configuration for the given Peer.","properties":{"receive_interval":{"description":"The time interval (in milliseconds) between heartbeat packets for BFD when receiving heartbeats.| For edge cluster type of bare metal, this value should be >= 50ms.| For edge cluster type of virtual machine or hybrid, this value should be >= 500ms.","title":"Receive interval for heartbeats","default":500,"format":"int64","maximum":60000,"minimum":50,"type":"integer"},"declare_dead_multiple":{"description":"Number of times a packet is missed before BFD declares the neighbor down.","title":"Number of times a packet is missed before BFD declares the neighbor down.","default":3,"format":"int64","maximum":16,"minimum":2,"type":"integer"},"transmit_interval":{"description":"The time interval (in milliseconds) between heartbeat packets for BFD when sending heartbeats.| For edge cluster type of bare metal, this value should be >= 300ms.| For edge cluster type of virtual machine or hybrid, this value should be >= 1000ms.","title":"Transmit interval for heartbeats","default":500,"format":"int64","maximum":60000,"minimum":50,"type":"integer"}},"title":"BFD configuration for the given Peer."},"DirectoryDomain":{"x-vmw-nsx-module":"DirectoryService","allOf":[{"$ref":"#/definitions/ManagedResource"},{"required":["ldap_servers","name","resource_type"],"discriminator":"resource_type","x-vmw-nsx-module":"DirectoryService","type":"object","properties":{"ldap_servers":{"items":{"$ref":"#/definitions/DirectoryLdapServer"},"type":"array","description":"Directory domain LDAP servers' information including host, name, port, protocol and so on.","maxItems":50,"title":"LDAP server of directory domain"},"name":{"type":"string","description":"Directory domain name which best describes the domain. It could be unique fqdn name or it could also be descriptive. There is no unique contraint for domain name among different domains.","title":"Directory domain name"},"resource_type":{"enum":["DirectoryAdDomain"],"type":"string","description":"Domain resource type comes from multiple sub-classes extending this base class. For example, DirectoryAdDomain is one accepted resource_type. If there are more sub-classes defined, they will also be accepted resource_type.","title":"Directory domain resource type"},"event_log_servers":{"description":"Directory domain Event Log server's information including host, name, protocol and so on.","title":"Event Log server of directory domain","items":{"$ref":"#/definitions/DirectoryEventLogServer"},"readOnly":true,"maxItems":50,"type":"array"}}}],"description":"Directory Domain","title":"Directory Domain"},"SubjectAltNames":{"x-vmw-nsx-module":"CertificateManager","type":"object","description":"A collection of subject alternative names","properties":{"dns_names":{"description":"A list of DNS names in subject alternative names","title":"DNS names","minItems":1,"items":{"description":"DNS name string in the \"preferred name syntax\", as specified by\nSection 3.5 of [RFC1034] and as modified by Section 2.1 of [RFC1123].\n","format":"hostname","type":"string"},"readOnly":true,"maxItems":128,"type":"array"},"ip_addresses":{"description":"A list of IP addresses in subject alternative names","title":"IP Addresses","minItems":1,"items":{"oneOf":[{"format":"ipv4"},{"format":"ipv6"}],"type":"string"},"readOnly":true,"maxItems":64,"type":"array"}},"title":"A collection of subject alternative names"},"TraceflowObservationReceived":{"x-vmw-nsx-module":"Traceflow","allOf":[{"$ref":"#/definitions/TraceflowObservation"},{"x-vmw-nsx-module":"Traceflow","type":"object","properties":{"vtep_label":{"format":"int64","type":"integer","description":"The virtual tunnel endpoint label","title":"The virtual tunnel endpoint label"},"uplink_name":{"type":"string","description":"The name of the uplink the traceflow packet is received on","title":"The name of the uplink the traceflow packet is received on"},"local_ip_address":{"description":"IP address of the destination end of the tunnel","format":"ip","type":"string"},"remote_ip_address":{"description":"IP address of the source end of the tunnel","format":"ip","type":"string"}}}]},"UpgradeStatus":{"x-vmw-nsx-module":"Upgrade","type":"object","properties":{"host_status":{"$ref":"#/definitions/HostUpgradeStatus"},"ccp_status":{"$ref":"#/definitions/CCPUpgradeStatus"},"edge_status":{"$ref":"#/definitions/EdgeUpgradeStatus"},"overall_upgrade_status":{"readOnly":true,"enum":["SUCCESS","FAILED","IN_PROGRESS","NOT_STARTED","PAUSING","PAUSED"],"type":"string","description":"Status of upgrade","title":"Status of upgrade"},"component_status":{"items":{"$ref":"#/definitions/ComponentUpgradeStatus"},"readOnly":true,"type":"array","description":"List of component statuses","title":"List of component statuses"}}},"Header":{"x-vmw-nsx-module":"NsxDashboard","type":"object","description":"Header of a widget that provides additional information. This will be shown at the container level. It includes details as label value pairs.","properties":{"content_alignment":{"default":"RIGHT","enum":["LEFT","RIGHT"],"type":"string","description":"Alignment of header labels.","title":"alignment for labelvalue pair"},"sub_header_widgets":{"minItems":0,"items":{"$ref":"#/definitions/WidgetItem"},"type":"array","description":"An array of widgets which will appear inside the container header Instead of 'sub_headers' property use this property.","title":"An array of widgets inside the container header"},"condition":{"maxLength":1024,"type":"string","description":"If the condition is met then the header will be applied. Examples of expression syntax are provided under 'example_request' section of 'CreateWidgetConfiguration' API.","title":"Expression for evaluating condition"},"sub_headers":{"description":"An array of label-value properties. This field is deprecated instead used 'sub_header_widgets' property to define header widgets.","title":"Rows","minItems":0,"items":{"$ref":"#/definitions/PropertyItem"},"x-deprecated":true,"type":"array"}},"title":"Widget Header"},"IpfixSwitchUpmProfile":{"x-vmw-nsx-module":"UpmIpfix","allOf":[{"$ref":"#/definitions/IpfixUpmProfile"},{"required":["priority","collector_profile","observation_domain_id"],"x-vmw-nsx-module":"UpmIpfix","type":"object","properties":{"priority":{"description":"This priority field is used to resolve conflicts in logical ports/switch\n which inherit multiple switch IPFIX profiles from NSGroups.\n\nOverride rule is : for multiple profiles inherited from NSGroups, the\none with highest priority (lowest number) overrides others; the profile\ndirectly applied to logical switch overrides profiles inherited from\nNSGroup; the profile directly applied to logical port overides profiles\ninherited from logical switch and/or nsgroup;\n\nThe IPFIX exporter will send records to collectors of final effective\nprofile only.\n","format":"int32","title":"Profile Priority","maximum":65536,"minimum":0,"type":"integer"},"collector_profile":{"type":"string","description":"Each IPFIX switching profile can have its own collector profile.\n","title":"UUID of IPFIX Collector Profile"},"idle_timeout":{"description":"The time in seconds after a flow is expired if no more packets matching\nthis flow are received by the cache.\n","title":"Idle Timeout","default":300,"format":"int32","maximum":3600,"minimum":60,"type":"integer"},"max_flows":{"description":"The maximum number of flow entries in each exporter flow cache.\n","title":"Max Flows","default":16384,"format":"int64","maximum":4294967295,"minimum":0,"type":"integer"},"observation_domain_id":{"description":"An identifier that is unique to the exporting process and used to\nmeter the Flows.\n","format":"int64","title":"Observation Domain ID","maximum":4294967295,"minimum":0,"type":"integer"},"active_timeout":{"description":"The time in seconds after a flow is expired even if more packets\nmatching this Flow are received by the cache.\n","title":"Active Timeout","default":300,"format":"int32","maximum":3600,"minimum":60,"type":"integer"},"export_overlay_flow":{"default":true,"type":"boolean","description":"It controls whether sample result includes overlay flow info.\n","title":"Export Overlay Flow"},"applied_tos":{"$ref":"#/definitions/AppliedTos"},"packet_sample_probability":{"description":"The probability in percentage that a packet is sampled. The value should be\n in range (0,100] and can only have three decimal places at most. The probability\n is equal for every packet.\n","title":"Packet Sample Probability","default":0.1,"exclusiveMinimum":true,"maximum":100,"minimum":0,"type":"number"}}}],"description":"The configuration for Internet protocol flow information export (IPFIX) and\nwould be enabled on the switching module to collect flow information.\n","title":"Switching IPFIX Profile"},"BFDProperties":{"x-vmw-nsx-module":"Tunnel","type":"object","description":"BFD information","properties":{"active":{"readOnly":true,"type":"boolean","description":"True if tunnel is active in a gateway HA setup","title":"True if tunnel is active in a gateway HA setup"},"state":{"readOnly":true,"enum":["UNKNOWN_STATE","ADMIN_DOWN","DOWN","INIT","UP"],"type":"string","description":"State of the BFD session","title":"State of the BFD session"},"remote_state":{"readOnly":true,"enum":["UNKNOWN_STATE","ADMIN_DOWN","DOWN","INIT","UP"],"type":"string","description":"State of the remote interface's BFD session","title":"State of the remote interface's BFD session"},"remote_diagnostic":{"readOnly":true,"type":"string","description":"A short message indicating what the remote interface's BFD session thinks is wrong in case of a problem","title":"Diagnostic message of a problem"},"forwarding":{"readOnly":true,"type":"boolean","description":"True if the BFD session believes this interface may be used to forward traffic","title":"True if the BFD session believes this interface may be used to forward traffic"},"diagnostic":{"readOnly":true,"type":"string","description":"A short message indicating what the BFD session thinks is wrong in case of a problem","title":"Diagnostic message of a problem"}},"title":"BFD information"},"ControlClusterNodeStatus":{"x-vmw-nsx-module":"ClusterManagement","type":"object","properties":{"mgmt_connection_status":{"$ref":"#/definitions/MgmtConnStatus"},"control_cluster_status":{"description":"Status of this node's connection to the control cluster","enum":["CONNECTED","DISCONNECTED","UNKNOWN"],"readOnly":true,"type":"string"}}},"LogicalRouterListResult":{"x-vmw-nsx-module":"LogicalRouter","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"LogicalRouter","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/LogicalRouter"},"type":"array","description":"Logical router list results","title":"Logical router list results"}}}]},"Tooltip":{"description":"Tooltip to be shown while hovering over the dashboard UI element.","title":"Tooltip","required":["text"],"x-vmw-nsx-module":"NsxDashboard","type":"object","properties":{"text":{"maxLength":1024,"type":"string","description":"Text to be shown on tooltip while hovering over UI element. The text would be wrapped if it exceeds 80 chars.","title":"Textbox shown at tooltip"},"heading":{"type":"boolean","description":"If true, displays tooltip text in bold","title":"Tooltip will be treated as header."},"condition":{"maxLength":1024,"type":"string","description":"If the condition is met then the tooltip will be applied. If no condition is provided, then the tooltip will be applied unconditionally. Examples of expression syntax are provided under 'example_request' section of 'CreateWidgetConfiguration' API.","title":"Expression for evaluating condition"}}},"DuplicateAddressBindingEntry":{"x-vmw-nsx-module":"LogicalPort","allOf":[{"$ref":"#/definitions/AddressBindingEntry"},{"x-vmw-nsx-module":"LogicalPort","type":"object","properties":{"conflicting_port":{"type":"string","description":"Provides the ID of the port on which the same address bidning exists\n","title":"ID of logical port with the same address binding"}}}],"description":"Duplicate address binding information","title":"Duplicate address binding information"},"LbVirtualServerWithRule":{"x-vmw-nsx-module":"LoadBalancer","required":["virtual_server"],"type":"object","properties":{"rules":{"items":{"$ref":"#/definitions/LbRule"},"type":"array","description":"It is used to add rules, update rules and bind rules to the virtual\nserver.\nTo add new rules, make sure that the rules have no identifier\nspecified, the new rules are automatically generated and associated to\nthe virtual server.\nIf the virtual server need to consume some existed rules without\nchange, those rules should not be specified in the list, otherwise,\nthe rules are updated.\nFor update_with_rules action, it supports rules delete and update.\nTo delete old rules, the rules should not be configured in new action,\nthe UUID of deleted rules should be removed from rule_ids.\nTo update rules, the rules should be specified with new change and\nconfigured with identifier.\nIf there are some rules which are not modified, those rule should not\nbe specified in the rules list, the UUID list of rules should be\nspecified in rule_ids of LbVirtualServer.\nThe property is deprecated as NSX-T Load Balancer is deprecated.\n","x-deprecated":true,"title":"Associated load balancer rules"},"virtual_server":{"$ref":"#/definitions/LbVirtualServer"}}},"MetadataProxy":{"x-vmw-nsx-module":"MetadataProxy","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"MetadataProxy","required":["metadata_server_url","edge_cluster_id"],"type":"object","properties":{"secret":{"type":"string","description":"secret to access metadata server","title":"secret to access metadata server"},"metadata_server_ca_ids":{"items":{"type":"string"},"type":"array","description":"The CAs referenced here must be uploaded to the truststore using the API\nPOST /api/v1/trust-management/certificates?action=import.\nUser needs to ensure a correct CA for this metedata server is used. The REST API can\nnot detect a wrong CA which was used to verify a different server. If the Metadata\nProxy reports an ERROR or NO_BACKUP status, user can check the metadata proxy log\nat transport node for a possible CA issue.\n","title":"uuids of CAs to verify metadata server certificate"},"edge_cluster_member_indexes":{"description":"If none is provided, the NSX will auto-select two edge-nodes from the given edge cluster.\nIf user provides only one edge node, there will be no HA support.\n","title":"edge cluster member indexes","minItems":0,"items":{"type":"integer","format":"int64"},"maxItems":2,"uniqueItems":true,"type":"array"},"crypto_protocols":{"items":{"description":"Metadata proxy supported cryptographic protocol","enum":["TLS_V1","TLS_V1_1","TLS_V1_2"],"type":"string"},"readOnly":false,"type":"array","description":"The cryptographic protocols listed here are supported by the metadata proxy.\nThe TLSv1.1 and TLSv1.2 are supported by default.\n","title":"metadata proxy supported cryptographic protocols."},"metadata_server_url":{"type":"string","description":"The URL in format scheme://host:port/path. Please note, the scheme supports only http\nand https as of now, port supports range 3000 - 9000, inclusive.\n","title":"metadata server url"},"attached_logical_port_id":{"readOnly":true,"type":"string","description":"id of attached logical port","title":"id of attached logical port"},"enable_standby_relocation":{"default":false,"type":"boolean","description":"Flag to enable the auto-relocation of standby Metadata Proxy in\ncase of edge node failure. Only tier 1 and auto placed Metadata\nProxy are considered for the relocation.\n","title":"Flag to enable standby Metadata proxy server relocation"},"edge_cluster_id":{"type":"string","description":"edge cluster uuid","title":"edge cluster uuid"}}}]},"LbVirtualServerStatus":{"x-vmw-nsx-module":"AggSvcLb","required":["virtual_server_id"],"type":"object","properties":{"status":{"enum":["UP","PARTIALLY_UP","PRIMARY_DOWN","DOWN","DETACHED","DISABLED","UNKNOWN"],"type":"string","description":"UP means that all primary members in default pool are in UP status.\nFor L7 virtual server, if there is no default pool, the virtual server\nwould be treated as UP.\nPARTIALLY_UP means that some(not all) primary members in default pool\nare in UP status. The size of these active primary members should be\nlarger than or equal to the certain number(min_active_members) which is\ndefined in LbPool. When there are no backup members which are in the UP\nstatus, the number(min_active_members) would be ignored.\nPRIMARY_DOWN means that less than certain(min_active_members) primary\nmembers in default pool are in UP status but backup members are in UP\nstatus, the connections would be dispatched to backup members.\nDOWN means that all primary and backup members are in DOWN status.\nDETACHED means that the virtual server is not bound to any service.\nDISABLED means that the admin state of the virtual server is disabled.\nUNKNOWN means that no status reported from transport-nodes. The\nassociated load balancer service may be working(or not working).\n","title":"Virtual server status"},"last_update_timestamp":{"type":"integer","description":"Timestamp when the data was last updated.","format":"int64"},"virtual_server_id":{"type":"string","description":"load balancer virtual server identifier","title":"load balancer virtual server identifier"}}},"EffectiveMemberTypeListResult":{"x-vmw-nsx-module":"NSGroup","required":["results"],"type":"object","properties":{"results":{"items":{"description":"Resource type valid for use in an NSGroupExpression","enum":["NSGroup","IPSet","MACSet","LogicalSwitch","LogicalPort","VirtualMachine","DirectoryGroup","VirtualNetworkInterface","TransportNode","CloudNativeServiceInstance","PhysicalServer","LogicalRouter","LogicalRouterPort"],"type":"string"},"type":"array","description":"Collection of member types for the given NSGroup","title":"Collection of member types for the given NSGroup"},"result_count":{"readOnly":true,"format":"int64","type":"integer","description":"Count of the member types in the results array","title":"Count of the member types in the results array"}}},"X509Crl":{"x-vmw-nsx-module":"CertificateManager","type":"object","description":"A CRL is a time-stamped list identifying revoked certificates.","properties":{"next_update":{"readOnly":true,"type":"string","description":"Next update time for the CRL."},"version":{"readOnly":true,"type":"string","description":"CRL's version number either 1 or 2."},"crl_entries":{"items":{"$ref":"#/definitions/X509CrlEntry"},"readOnly":true,"type":"array","description":"List of X509CrlEntry."},"issuer":{"readOnly":true,"type":"string","description":"Issuer's distinguished name. (DN)"}},"title":"A CRL is a time-stamped list identifying revoked certificates."},"BGPCommunityListListResult":{"x-vmw-nsx-module":"Routing","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"Routing","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/BGPCommunityList"},"type":"array","description":"Paginated list of bgp community lists","title":"List of bgp communities"}}}]},"LbServiceStatus":{"x-vmw-nsx-module":"AggSvcLb","required":["service_id"],"type":"object","properties":{"cpu_usage":{"format":"int64","type":"integer","description":"Cpu usage in percentage","title":"Cpu usage in percentage"},"memory_usage":{"format":"int64","type":"integer","description":"Memory usage in percentage","title":"Memory usage in percentage"},"last_update_timestamp":{"type":"integer","description":"Timestamp when the data was last updated","format":"int64"},"error_message":{"type":"string","description":"Error message, if available","title":"Error message, if available"},"standby_transport_nodes":{"items":{"type":"string"},"type":"array","description":"Ids of load balancer service related standby transport nodes","title":"Ids of load balancer service related standby transport nodes"},"service_status":{"enum":["UP","PARTIALLY_UP","DOWN","ERROR","NO_STANDBY","DETACHED","DISABLED","UNKNOWN"],"type":"string","description":"UP means the load balancer service is working fine on both\ntransport-nodes(if have);\nPARTIALLY_UP means that some DLB instances on transport node are\nworking successfully and some instances are not working successfully;\nDOWN means the load balancer service is down on both transport-nodes\n(if have), hence the load balancer will not respond to any requests;\nERROR means error happens on transport-node(s) or no status is\nreported from transport-node(s). The load balancer service may be\nworking (or not working);\nNO_STANDBY means load balancer service is working in one of the\ntransport node while not in the other transport-node (if have). Hence\nif the load balancer service in the working transport-node goes down,\nthe load balancer service will go down;\nDETACHED means that the load balancer service has no attachment setting\nand is not instantiated in any transport nodes;\nDISABLED means that admin state of load balancer service is DISABLED;\nUNKNOWN means that no status reported from transport-nodes.The load\nbalancer service may be working(or not working).\n","title":"Status of load balancer service"},"virtual_servers":{"items":{"$ref":"#/definitions/LbVirtualServerStatus"},"type":"array","description":"status of load balancer virtual servers","title":"status of load balancer virtual servers"},"active_transport_nodes":{"items":{"type":"string"},"type":"array","description":"Ids of load balancer service related active transport nodes","title":"Ids of load balancer service related active transport nodes"},"instance_detail_per_tn":{"items":{"$ref":"#/definitions/LbServiceInstanceDetailPerTransportNode"},"type":"array","description":"Details of load balancer service instance per transport node.\n","title":"Details of load balancer service instance per transport node"},"pools":{"items":{"$ref":"#/definitions/LbPoolStatus"},"type":"array","description":"status of load balancer pools","title":"status of load balancer pools"},"service_id":{"type":"string","description":"Load balancer service identifier","title":"Load balancer service identifier"}}},"NamedTeamingPolicy":{"x-vmw-nsx-module":"UplinkHostSwitchProfile","allOf":[{"$ref":"#/definitions/TeamingPolicy"},{"required":["name"],"x-vmw-nsx-module":"UplinkHostSwitchProfile","type":"object","properties":{"name":{"type":"string","description":"An uplink teaming policy of a given name defined in UplinkHostSwitchProfile. The names of all NamedTeamingPolicies in an UplinkHostSwitchProfile must be different, but a name can be shared by different UplinkHostSwitchProfiles. Different TransportNodes can use different NamedTeamingPolicies having the same name in different UplinkHostSwitchProfiles to realize an uplink teaming policy on a logical switch. An uplink teaming policy on a logical switch can be any policy defined by a user; it does not have to be a single type of FAILOVER or LOADBALANCE. It can be a combination of types, for instance, a user can define a policy with name \"MyHybridTeamingPolicy\" as \"FAILOVER on all ESX TransportNodes and LOADBALANCE on all KVM TransportNodes\". The name is the key of the teaming policy and can not be changed once assigned.","title":"The name of the uplink teaming policy"}}}],"description":"Uplink Teaming Policy with a name that can be referenced by logical switches","title":"Uplink Teaming Policy with a name that can be referenced by logical switches"},"UcStateProperties":{"x-vmw-nsx-module":"MISSING_MODULE","type":"object","description":"Upgrade Coordinator state properties","properties":{"update_uc_state_properties":{"default":true,"type":"boolean","description":"Flag for updating upgrade-coodinator state properties to database","title":"Flag for updating upgrade-coodinator state properties to database"}},"title":"Upgrade Coordinator state properties"},"ServiceDeploymentIssue":{"description":"Type of issue and detailed description of the issue in case of deployment failure.","title":"Service deployment issue","required":["issue_type"],"x-vmw-nsx-module":"ServiceInsertionVMDeployment","type":"object","properties":{"issue_description":{"type":"string","description":"Description of issue encountered while service deployment.","title":"Description of issue encountered while service deployment"},"issue_timestamp":{"type":"string","description":"Timestamp when issue was issue encountered while service deployment.","title":"Timestamp when issue was encountered while service deployment"},"issue_type":{"type":"string","description":"Type of issue encountered while service deployment.","title":"Type of issue encountered while service deployment"}}},"NodeInfoListResult":{"x-vmw-nsx-module":"Migration","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"Migration","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/NodeInfo"},"type":"array","description":"Paged Collection of Nodes","title":"Paged Collection of Nodes"}}}]},"ManagementClusterStatus":{"x-vmw-nsx-module":"ClusterManagement","type":"object","properties":{"status":{"readOnly":true,"enum":["INITIALIZING","UNSTABLE","DEGRADED","STABLE","UNKNOWN"],"type":"string","description":"The current status of the management cluster","title":"The current status of the management cluster"},"offline_nodes":{"items":{"$ref":"#/definitions/ManagementPlaneBaseNodeInfo"},"readOnly":true,"type":"array","description":"Current missing management plane nodes"},"required_members_for_initialization":{"items":{"$ref":"#/definitions/ClusterInitializationNodeInfo"},"readOnly":true,"type":"array","description":"The details of the cluster nodes required for cluster initialization"},"online_nodes":{"items":{"$ref":"#/definitions/ManagementPlaneBaseNodeInfo"},"readOnly":true,"type":"array","description":"Current alive management plane nodes"}}},"NodeRtepIpsConfig":{"x-vmw-nsx-module":"EdgeClusters","type":"object","properties":{"member_index":{"readOnly":true,"format":"int32","type":"integer","description":"System generated index for cluster member","title":"System generated index for cluster member"},"rtep_ips":{"items":{"description":"IPv4 or IPv6 address","format":"ip","type":"string"},"readOnly":true,"type":"array","description":"Remote tunnel endpoint ip address.","title":"Remote tunnel endpoint ip address."},"transport_node_id":{"readOnly":true,"type":"string","description":"Identifier of the transport node backed by an Edge node","title":"UUID of edge transport node"}}},"NodeStatus":{"x-vmw-nsx-module":"FabricNode","type":"object","description":"Runtime status information of the fabric node.","properties":{"mpa_connectivity_status":{"readOnly":true,"enum":["UP","DOWN","UNKNOWN"],"type":"string","description":"Indicates the fabric node's MP<->MPA channel connectivity status, UP, DOWN, UNKNOWN.","title":"Indicates the fabric node's MP<->MPA channel connectivity status, UP, DOWN, UNKNOWN."},"lcp_connectivity_status_details":{"description":"Details, if any, about the current LCP<->CCP channel connectivity status of the fabric node.","title":"Details, if any, about the current LCP<->CCP channel connectivity status of the fabric node.","default":[],"items":{"$ref":"#/definitions/ControlConnStatus"},"readOnly":true,"type":"array"},"mpa_connectivity_status_details":{"readOnly":true,"type":"string","description":"Details, if any, about the current MP<->MPA channel connectivity status of the fabric node.","title":"Details, if any, about the current MP<->MPA channel connectivity status of the fabric node."},"external_id":{"type":"string","description":"HostNode external id","title":"HostNode external id"},"software_version":{"readOnly":true,"type":"string","description":"Software version of the fabric node.","title":"Software version of the fabric node."},"maintenance_mode":{"readOnly":true,"enum":["OFF","ENTERING","ON","EXITING"],"type":"string","description":"Indicates the fabric node's status of maintenance mode, OFF, ENTERING, ON, EXITING.","title":"Indicates the fabric node's status of maintenance mode, OFF, ENTERING, ON, EXITING."},"inventory_sync_paused":{"readOnly":true,"type":"boolean","description":"Is true if inventory sync is paused else false","title":"Is true if inventory sync is paused else false"},"system_status":{"$ref":"#/definitions/NodeStatusProperties"},"inventory_sync_reenable_time":{"description":"Inventory sync auto re-enable target time, in epoch milis","format":"int64","readOnly":true,"type":"integer"},"lcp_connectivity_status":{"description":"Indicates the fabric node's LCP<->CCP channel connectivity status, UP, DOWN, DEGRADED, UNKNOWN.","title":"Indicates the fabric node's LCP<->CCP channel connectivity status, UP, DOWN, DEGRADED, UNKNOWN.","default":"UNKNOWN","enum":["UP","DOWN","DEGRADED","UNKNOWN"],"readOnly":true,"type":"string"},"last_heartbeat_timestamp":{"description":"Timestamp of the last heartbeat status change, in epoch milliseconds.","format":"int64","readOnly":true,"type":"integer"},"last_sync_time":{"description":"Timestamp of the last successful update of Inventory, in epoch milliseconds.","format":"int64","readOnly":true,"type":"integer"},"host_node_deployment_status":{"readOnly":true,"enum":["NOT_PREPARED","INSTALL_IN_PROGRESS","INSTALL_FAILED","INSTALL_SUCCESSFUL","INSTALL_SKIPPED","UNINSTALL_IN_PROGRESS","UNINSTALL_FAILED","UNINSTALL_SUCCESSFUL","UNINSTALL_SCHEDULED","UNINSTALL_SKIPPED","UPGRADE_IN_PROGRESS","UPGRADE_FAILED","PENDING_UPGRADE","NOT_AVAILABLE","VM_DEPLOYMENT_QUEUED","VM_DEPLOYMENT_IN_PROGRESS","VM_DEPLOYMENT_FAILED","VM_POWER_ON_IN_PROGRESS","VM_POWER_ON_FAILED","REGISTRATION_PENDING","NODE_NOT_READY","NODE_READY","VM_POWER_OFF_IN_PROGRESS","VM_POWER_OFF_FAILED","VM_UNDEPLOY_IN_PROGRESS","VM_UNDEPLOY_FAILED","VM_UNDEPLOY_SUCCESSFUL","EDGE_CONFIG_ERROR","VM_DEPLOYMENT_RESTARTED","REGISTRATION_FAILED","HOST_DISCONNECTED","POWERED_OFF","TRANSPORT_NODE_SYNC_PENDING","TRANSPORT_NODE_CONFIGURATION_MISSING","EDGE_HARDWARE_NOT_SUPPORTED","MULTIPLE_OVERLAY_TZS_NOT_SUPPORTED","TN_OVERLAY_TZ_IN_USE_BY_EDGE_CLUSTER","TZ_ENDPOINTS_NOT_SPECIFIED","NO_PNIC_PREPARED_IN_EDGE","APPLIANCE_INTERNAL_ERROR","VTEP_DHCP_NOT_SUPPORTED","UNSUPPORTED_HOST_SWITCH_PROFILE","UPLINK_HOST_SWITCH_PROFILE_NOT_SPECIFIED","HOSTSWITCH_PROFILE_NOT_FOUND","LLDP_SEND_ENABLED_NOT_SUPPORTED","UNSUPPORTED_NAMED_TEAMING_POLICY","MULTIPLE_UPLINKS_IN_NAMED_TEAMING_NOT_SUPPORTED_IF_UPLINK_IN_DEFAULT_TEAMING","LBSRCID_NOT_SUPPORTED_FOR_EDGE_VM","LACP_NOT_SUPPORTED_FOR_EDGE_VM","STANDBY_UPLINKS_NOT_SUPPORTED_FOR_EDGE_VM","MULTIPLE_ACTIVE_UPLINKS_NOT_SUPPORTED_FOR_EDGE","UNSUPPORTED_LACP_LB_ALGO_FOR_NODE","EDGE_NODE_VERSION_NOT_SUPPORTED","NO_PNIC_SPECIFIED_IN_TN","INVALID_PNIC_DEVICE_NAME","TRANSPORT_NODE_READY","UNSUPPORTED_DEFAULT_TEAMING_POLICY","MPA_DISCONNECTED","VM_NETWORK_EDIT_PENDING","VM_RENAME_PENDING","VM_CONFIG_EDIT_PENDING","VM_NETWORK_EDIT_FAILED","VM_RENAME_FAILED","VM_CONFIG_EDIT_FAILED","VM_CONFIG_DISCREPANCY","VM_NODE_REFRESH_FAILED","VM_PLACEMENT_REFRESH_FAILED","REGISTRATION_TIMEDOUT","LOGICAL_SWITCH_NAMED_TEAMING_HAS_NO_PNIC_BACKING","UPLINK_FROM_TEAMING_POLICY_NOT_MAPPED","REPLACE_FAILED","DELETE_VM_IN_REDEPLOY_FAILED","DEPLOY_VM_IN_REDEPLOY_FAILED","INSUFFICIENT_RESOURCES_IN_EDGE_NODE_FOR_SERVICE"],"type":"string","description":"This enum specifies the current nsx install state for host node or\ncurrent deployment and ready state for edge node.\nThe ready status 'NODE_READY' indicates whether edge node is\nready to become a transport node.\nThe status 'EDGE_CONFIG_ERROR' indicates that edge hardware or underlying\nhost is not supported. After all fabric level operations are done for an\nedge node, this value indicates transport node related configuration\nissues and state as relevant.\n","title":"Install/Uninstall status of deployment."}},"title":"Runtime status information of the fabric node."},"NetworkError":{"x-vmw-nsx-module":"InventoryContainerObj","type":"object","description":"Network error related to container objects.","properties":{"error_message":{"readOnly":true,"type":"string","description":"Detailed message of network related error.","title":"Error message"},"error_code":{"readOnly":true,"type":"string","description":"Error code of network related error.","title":"Error code"},"spec":{"readOnly":true,"type":"string","description":"Additional error information in json format.","title":"Other specifications"}},"title":"Network Error"},"ServiceConfigListResult":{"x-vmw-nsx-module":"ServiceConfig","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"ServiceConfig","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/ServiceConfig"},"type":"array","description":"service config list results","title":"service config list results"}}}],"description":"Paged Collection of service configs","title":"Paged Collection of service configs"},"RuntimeInterfaceStatistics":{"x-vmw-nsx-module":"ServiceInsertionVMDeployment","allOf":[{"$ref":"#/definitions/SIAggregatedDataCounterEx"},{"x-vmw-nsx-module":"ServiceInsertionVMDeployment","type":"object","properties":{"last_update_timestamp":{"description":"Timestamp when the data was last updated; unset if data source has never updated the data.","format":"int64","readOnly":true,"type":"integer"},"interface_index":{"readOnly":true,"format":"int64","type":"integer","description":"Index of the interface","title":"Index of the interface"}}}]},"FeaturePermissionArray":{"x-vmw-nsx-module":"AAA","required":["feature_permissions"],"type":"object","properties":{"feature_permissions":{"items":{"$ref":"#/definitions/FeaturePermission"},"type":"array","description":"Array of FeaturePermission","title":"Array of FeaturePermission"}}},"DistributedVirtualSwitch":{"x-vmw-nsx-module":"InventoryCmObj","allOf":[{"$ref":"#/definitions/VirtualSwitch"},{"x-vmw-nsx-module":"InventoryCmObj","type":"object","properties":{"discovered_nodes":{"items":{"$ref":"#/definitions/DiscoveredNode"},"readOnly":true,"type":"array","description":"Array of discovered nodes connected to this switch.","title":"Array of discovered nodes connected"},"uplink_portgroup":{"$ref":"#/definitions/DistributedVirtualPortgroup"},"uuid":{"readOnly":true,"type":"string","description":"UUID of the switch","title":"UUID of the switch"},"origin_properties":{"items":{"$ref":"#/definitions/KeyValuePair"},"readOnly":true,"type":"array","description":"Key-Value map of additional properties of switch","title":"Key-Value map of additional properties of switch"},"lacp_group_configs":{"items":{"$ref":"#/definitions/LacpGroupConfigInfo"},"readOnly":false,"type":"array","description":"It contains information about VMware specific multiple dynamic\nLACP groups.\n","title":"Array of Link Aggregation Control Protocol (LACP) configuration"},"uplink_port_names":{"items":{"type":"string"},"readOnly":true,"type":"array","description":"The uniform name of uplink ports on each host.","title":"Uplink port names"}}}],"description":"DistributedVirtualSwitch on a VC","title":"DistributedVirtualSwitch on a VC"},"IdfwStandaloneHostsSwitchSetting":{"description":"Identity Firewall standalone hosts switch setting. This setting enables or\ndisables Identity Firewall feature on all standalone hosts.\n","title":"Identity Firewall standalone hosts switch setting","required":["standalone_hosts_enabled"],"x-vmw-nsx-module":"IdentityFirewall","type":"object","properties":{"standalone_hosts_enabled":{"type":"boolean","description":"IDFW standalone hosts switch (true=Enabled / false=Disabled).","title":"IDFW standalone hosts switch"}}},"DonutPart":{"description":"Represents an entity or portion to be plotted on a donut or stats chart.","title":"Portion of a donut or stats chart","required":["field"],"x-vmw-nsx-module":"NsxDashboard","type":"object","properties":{"field":{"maxLength":1024,"type":"string","description":"A numerical value that represents the portion or entity of the donut or stats chart.","title":"Value of the portion or entity of donut or stats chart"},"hide_empty_legend":{"default":false,"type":"boolean","description":"If true, legend will be shown only if the data for the part is available. This is applicable only if legends are specified in widget configuration.","title":"Hide the legend if the data for the part is not available"},"condition":{"type":"string","description":"If the condition is met then the part will be displayed. Examples of expression syntax are provided under 'example_request' section of 'CreateWidgetConfiguration' API.","title":"Expression for evaluating condition"},"drilldown_id":{"type":"string","description":"Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget.","title":"Id of drilldown widget"},"label":{"$ref":"#/definitions/Label"},"navigation":{"type":"string","description":"Hyperlink of the specified UI page that provides details. If drilldown_id is provided, then navigation cannot be used.","title":"Navigation to a specified UI page"},"tooltip":{"minItems":0,"items":{"$ref":"#/definitions/Tooltip"},"type":"array","description":"Multi-line text to be shown on tooltip while hovering over the portion.","title":"Multi-line tooltip"},"render_configuration":{"minItems":0,"items":{"$ref":"#/definitions/RenderConfiguration"},"type":"array","description":"Additional rendering or conditional evaluation of the field values to be performed, if any.","title":"Render Configuration"}}},"EdgeCluster":{"x-vmw-nsx-module":"EdgeClusters","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"EdgeClusters","type":"object","properties":{"member_node_type":{"description":"Edge cluster is homogenous collection of transport nodes.\nHence all transport nodes of the cluster must be of same type.\nThis readonly field shows the type of transport nodes.\n","enum":["EDGE_NODE","PUBLIC_CLOUD_GATEWAY_NODE","UNKNOWN"],"readOnly":true,"type":"string"},"members":{"items":{"$ref":"#/definitions/EdgeClusterMember"},"type":"array","description":"EdgeCluster only supports homogeneous members.\nThese member should be backed by either EdgeNode or PublicCloudGatewayNode.\nTransportNode type of these nodes should be the same.\nDeploymentType (VIRTUAL_MACHINE|PHYSICAL_MACHINE) of these EdgeNodes is\nrecommended to be the same. EdgeCluster supports members of different\ndeployment types.\n","title":"Edge cluster members"},"node_rtep_ips":{"items":{"$ref":"#/definitions/NodeRtepIpsConfig"},"readOnly":true,"type":"array","description":"List of remote tunnel endpoint ipaddress configured on edge cluster for each transport node.","title":"Remote tunnel endpoint ip address."},"cluster_profile_bindings":{"items":{"$ref":"#/definitions/ClusterProfileTypeIdEntry"},"type":"array","description":"Edge cluster profile bindings","title":"Edge cluster profile bindings"},"enable_inter_site_forwarding":{"readOnly":true,"type":"boolean","description":"Flag should be only use in federation for inter site l2 and l3 forwarding.\nBefore enabling this flag, all the edge cluster members must have remote\ntunnel endpoint configured. TIER0/TIER1 logical routers managed by GM\nmust be associated with edge cluster which has inter-site forwarding\nenabled.\n","title":"Flag to enable inter site forwarding"},"allocation_rules":{"items":{"$ref":"#/definitions/AllocationRule"},"type":"array","description":"Set of allocation rules and respected action for auto placement of\nlogical router, DHCP and MDProxy on edge cluster members.\n","title":"Allocation rules for auto placement"},"deployment_type":{"description":"This field is a readonly field which shows the deployment_type of members.\nIt returns UNKNOWN if there are no members, and returns VIRTUAL_MACHINE|\nPHYSICAL_MACHINE if all edge members are VIRTUAL_MACHINE|PHYSICAL_MACHINE.\nIt returns HYBRID if the cluster contains edge members of both types\nVIRTUAL_MACHINE and PHYSICAL_MACHINE.\n","enum":["VIRTUAL_MACHINE","PHYSICAL_MACHINE","UNKNOWN"],"readOnly":true,"type":"string"}}}]},"CrlDistributionPointStatus":{"x-vmw-nsx-module":"CertificateManager","type":"object","description":"Reference to a CRL Distribution Point where to fetch a CRL","properties":{"status":{"description":"Status of the fetched CRL for this CrlDistributionPoint","enum":["NOT_READY","FETCHING","READY","ERROR"],"readOnly":true,"type":"string"},"error_message":{"readOnly":true,"type":"string","description":"Error message when fetching the CRL failed.","title":"Error Message"}},"title":"Reference to a CRL Distribution Point where to fetch a CRL"},"IDSEventsBySignatureResult":{"x-vmw-nsx-module":"IDSMetrics","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"IDSMetrics","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/IDSEventsBySignature"},"readOnly":true,"type":"array","description":"List of all intrusions detected, grouped by signature. The details include signature id, name, severity, timestamp, and total number of attempts per signature.","title":"List of all intrusions detected"}}}],"description":"List of all intrusions that are detected grouped by signature, it\ncontains minimal details about the intrusions.\n","title":"List of intrusions grouped by signature"},"ComputeManagerStatus":{"x-vmw-nsx-module":"InventoryCmObj","type":"object","description":"Runtime status information of the compute manager","properties":{"version":{"readOnly":true,"type":"string","description":"Version of the compute manager","title":"Version of the compute manager"},"connection_status":{"readOnly":true,"enum":["UP","DOWN","CONNECTING"],"type":"string","description":"Status of connection with the compute manager","title":"Status of connection with the compute manager"},"connection_errors":{"items":{"$ref":"#/definitions/ErrorInfo"},"readOnly":true,"type":"array","description":"Errors when connecting with compute manager","title":"Errors when connecting with compute manager"},"oidc_end_point_id":{"readOnly":true,"type":"string","description":"If Compute manager is trusted as authorization server, then\nthis Id will be Id of corresponding oidc end point.\n","title":"Specifies Id of corresponding OidcEndPoint"},"last_sync_time":{"description":"Timestamp of the last successful update of Inventory, in epoch milliseconds.","format":"int64","readOnly":true,"type":"integer"},"connection_status_details":{"readOnly":true,"type":"string","description":"Details about connection status","title":"Details about connection status"},"registration_errors":{"items":{"$ref":"#/definitions/ErrorInfo"},"readOnly":true,"type":"array","description":"Errors when registering with compute manager","title":"Errors when registering with compute manager"},"registration_status":{"readOnly":true,"enum":["REGISTERED","UNREGISTERED","REGISTERING","REGISTERED_WITH_ERRORS"],"type":"string","description":"Registration status of compute manager","title":"Registration status of compute manager"}},"title":"Runtime status information of the compute manager"},"DnsTtlConfig":{"description":"Firewall to use TTL config to manage firewall cache to expire snooped FQDN entries from DNS response.","title":"DNS TTL config","required":["dns_ttl_type"],"x-vmw-nsx-module":"FirewallProfile","type":"object","properties":{"ttl":{"description":"The number of seconds that snooped DNS responses are retained in the cache. Used only when dns_ttl_type is USE_TTL.","title":"DNS server TTL","default":86400,"format":"int64","maximum":864000,"minimum":3600,"type":"integer"},"dns_ttl_type":{"enum":["USE_TTL","AUTO","NEVER_EXPIRE"],"type":"string","description":"TTL type to decide how to manage ttl.","title":"TTL type."}}},"LbPoolStatistics":{"x-vmw-nsx-module":"AggSvcLb","required":["statistics","pool_id"],"type":"object","properties":{"last_update_timestamp":{"type":"integer","description":"Timestamp when the data was last updated","format":"int64"},"statistics":{"$ref":"#/definitions/LbStatisticsCounter"},"pool_id":{"type":"string","description":"Load balancer pool identifier","title":"Load balancer pool identifier"},"members":{"items":{"$ref":"#/definitions/LbPoolMemberStatistics"},"type":"array","description":"Statistics of load balancer pool members","title":"Statistics of load balancer pool members"}}},"DirectoryAdDomain":{"x-vmw-nsx-module":"DirectoryService","allOf":[{"$ref":"#/definitions/DirectoryDomain"},{"required":["base_distinguished_name","netbios_name"],"x-vmw-nsx-module":"DirectoryService","type":"object","properties":{"base_distinguished_name":{"type":"string","description":"Each active directory domain has a domain naming context (NC), which contains domain-specific data. The root of this naming context is represented by a domain's distinguished name (DN) and is typically referred to as the NC head.","title":"Directory domain base distinguished name"},"sync_settings":{"$ref":"#/definitions/DirectoryDomainSyncSettings"},"netbios_name":{"type":"string","description":"NetBIOS names can contain all alphanumeric characters except for the certain disallowed characters. Names can contain a period, but names cannot start with a period. NetBIOS is similar to DNS in that it can serve as a directory service, but more limited as it has no provisions for a name hierarchy and names are limited to 15 characters. The netbios name is case insensitive and is stored in upper case regardless of input case.","title":"Directory domain NETBIOS name"},"selective_sync_settings":{"$ref":"#/definitions/SelectiveSyncSettings"}}}],"description":"Active Directory Domain","title":"Active Directory Domain"},"GlobalConfigsListResult":{"x-vmw-nsx-module":"GlobalConfigs","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"GlobalConfigs","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/GlobalConfigs"},"type":"array","description":"Domain specific global configuration.","title":"Domain specific global configuration."}}}],"description":"A list of global configurations grouped by their types","title":"Global configurations query result"},"StatItem":{"description":"Displayed as a single number. It can be used to show the characteristics of entities such as Logical Switches, Firewall Rules, and so on. For example, number of logical switches and their admin states.","title":"Statistic of an entity","required":["value"],"x-vmw-nsx-module":"NsxDashboard","type":"object","properties":{"drilldown_id":{"type":"string","description":"Id of drilldown widget, if any. Id should be a valid id of an existing widget.","title":"Id of drilldown widget"},"total":{"type":"string","description":"If expression for total is specified, it evaluates it. Total can be omitted if not needed to be shown.","title":"Total"},"tooltip":{"minItems":0,"items":{"$ref":"#/definitions/Tooltip"},"type":"array","description":"Multi-line text to be shown on tooltip while hovering over the stat.","title":"Multi-line tooltip"},"value":{"maxLength":1024,"type":"string","description":"Expression for stat to be displayed.","title":"Stat"}}},"DiscoveredNodeListResult":{"x-vmw-nsx-module":"InventoryCmObj","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"InventoryCmObj","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/DiscoveredNode"},"type":"array","description":"Discovered Node list results","title":"Discovered Node list results"}}}],"description":"Discovered Node list result","title":"Discovered Node list result"},"NotificationWatcher":{"x-vmw-nsx-module":"NfwConfig","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"NfwConfig","required":["method","authentication_scheme","uri","server"],"type":"object","properties":{"description":{"type":"string","description":"Optional description that can be associated with this NotificationWatcher.","title":"Description associated with this notification watcher"},"send_timeout":{"description":"Optional time duration (in seconds) to specify request timeout to notification watcher. If the send reaches the timeout, will try to send refresh_needed as true in the next time interval. The default value is 30 seconds.","format":"int64","default":30,"title":"Optional time period within which response for a notification request should be received from this NotificationWatcher","minimum":1,"type":"integer"},"uri":{"type":"string","description":"URI notification requests should be made on the specified server.","title":"URI notification requests should be made on the server"},"id":{"readOnly":true,"type":"string","description":"System generated identifier to identify a notification watcher uniquely.\n","title":"Identifier to identify a notification watcher uniquely"},"certificate_sha256_thumbprint":{"type":"string","description":"Contains the hex-encoded SHA256 thumbprint of the HTTPS certificate. It must be specified if use_https is set to true.","title":"SHA256 thumbprint of the HTTPS certificate"},"method":{"enum":["POST"],"type":"string","description":"Type of method notification requests should be made on the specified server. The value must be set to POST.","title":"Type of method notification requests should be made on the server"},"send_interval":{"format":"int64","minimum":30,"type":"integer","description":"Optional time interval (in seconds) for which notification URIs will be accumulated. At the end of the time interval the accumulated notification URIs will be sent to this NotificationWatcher in the form of zero (nothing accumulated) or more notification requests as soon as possible. If it is not specified, the NotificationWatcher should expected to receive notifications at any time.","title":"Optional time interval for which notification URIs will be accumulated"},"max_send_uri_count":{"description":"If the number of notification URIs accumulated in specified send_interval exceeds max_send_uri_count, then multiple notification requests (each with max_send_uri_count or less number of notification URIs) will be sent to this NotificationWatcher. The default value is 5000.","title":"Optional maximum number of notification URIs batched in a single notification request","default":5000,"format":"int64","maximum":5000,"minimum":1,"type":"integer"},"authentication_scheme":{"$ref":"#/definitions/NotificationAuthenticationScheme"},"server":{"type":"string","description":"IP address or fully qualified domain name of the partner/customer watcher.","title":"IP address or fully qualified domain name of watcher"},"port":{"description":"Optional integer port value to specify a non-standard HTTP or HTTPS port.","format":"int64","title":"Integer port value to specify a non-standard HTTP or HTTPS port","maximum":65535,"minimum":0,"type":"integer"},"use_https":{"default":false,"type":"boolean","description":"Optional field, when set to true indicates REST API server should use HTTPS.","title":"Flag to indicate if REST API server should use HTTPS"}}}]},"UpgradeCheckCsvListResult":{"x-vmw-nsx-module":"Upgrade","allOf":[{"$ref":"#/definitions/CsvListResult"},{"x-vmw-nsx-module":"Upgrade","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/UpgradeCheckCsvRecord"},"type":"array"}}}]},"AutomaticHealthCheckToggle":{"x-vmw-nsx-module":"HealthCheck","allOf":[{"$ref":"#/definitions/ManagedResource"},{"required":["enabled"],"x-vmw-nsx-module":"HealthCheck","type":"object","properties":{"enabled":{"default":false,"type":"boolean","description":"Status of automatic health check","title":"Status of automatic health check"}}}],"description":"Toggle to enable/disable automatic health check.\n","title":"Automatic Health Check Toggle"},"SwitchoverStatus":{"x-vmw-nsx-module":"SiteManagerModule","required":["note","overall_status","number_of_steps","current_step_number"],"type":"object","properties":{"current_step":{"$ref":"#/definitions/ProgressItem"},"note":{"type":"string","description":"Special messages, most of the time this will be empty, i.e. If SM performing the operation went down, another SM will restart the progress.","title":"Special messages, most of the time this will be empty, i.e. If SM performing the operation went down, another SM will restart the progress."},"overall_status":{"enum":["NOT_STARTED","RUNNING","ERROR","COMPLETE"],"type":"string","description":"Status of the operation","title":"Status of the operation"},"number_of_steps":{"format":"int64","type":"integer","description":"Total number of steps","title":"Total number of steps"},"current_step_number":{"format":"int64","type":"integer","description":"Current number","title":"Current number"}}},"NSGroup":{"x-vmw-nsx-module":"NSGroup","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"NSGroup","type":"object","properties":{"member_count":{"readOnly":true,"format":"int64","type":"integer","description":"Count of the members added to this NSGroup","title":"Count of the members added to this NSGroup"},"members":{"items":{"$ref":"#/definitions/NSGroupSimpleExpression"},"type":"array","description":"Reference to the direct/static members of the NSGroup.\nCan be ID based expressions only. VirtualMachine cannot\nbe added as a static member.\n","maxItems":500,"title":"Members of NSGroup"},"membership_criteria":{"items":{"$ref":"#/definitions/NSGroupExpression"},"type":"array","description":"List of tag or name based expressions which define the dynamic membership criteria\nfor this NSGroup. An object must satisfy atleast one of these expressions\nto qualify as a member of this group.\nIt is not recommended to use ID based expressions in this section.\nID based expression should be used in \"members\" section\n","maxItems":5,"title":"The criteria for membership of this NSGroup"}}}],"description":"NSGroups are recursive groupings of different NSX elements (logical and physical), typically used in policy definitions.","title":"Networking and Security Group"},"IPSecVPNDPDProfile":{"x-vmw-nsx-module":"IPSecVPN","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"IPSecVPN","type":"object","properties":{"retry_count":{"description":"Maximum number of DPD messages retry attempts. This value is applicable for both dpd probe modes, periodic and on-demand.","title":"Retry count","default":5,"format":"int64","maximum":100,"minimum":1,"type":"integer"},"enabled":{"default":true,"type":"boolean","description":"If true, enable dead peer detection.","title":"Enable dead peer detection (DPD)"},"dpd_probe_mode":{"default":"PERIODIC","enum":["PERIODIC","ON_DEMAND"],"type":"string","description":"DPD probe mode is used to query the liveliness of the peer. Two modes are possible -\nPERIODIC - is used to query the liveliness of the peer at regular\nintervals (dpd_probe_interval). It does not take into consideration\ntraffic coming from the peer. The benefit of this mode over the\non-demand mode is earlier detection of dead peers.\nHowever, use of periodic DPD incurs extra overhead. When\ncommunicating to large numbers of peers, please consider using on-demand DPD instead.\nON_DEMAND - is used to query the liveliness of the peer by\ninstructing the local endpoint to send DPD message to a peer if\nthere is traffic to send to the peer AND the peer was idle for\ndpd_probe_interval seconds (i.e. there was no traffic from the\npeer for dpd_probe_interval seconds)\n","title":"DPD probe mode"},"dpd_probe_interval":{"format":"int64","type":"integer","description":"When the DPD probe mode is periodic, this interval is the number\nof seconds between DPD messages.\nWhen the DPD probe mode is on-demand, this interval is the number\nof seconds during which traffic is not received from the peer before\nDPD retry messages are sent if there is IPSec traffic to send.\nFor PERIODIC Mode:\n Minimum: 3\n Maximum: 360\n Default: 60\nFor ON_DEMAND Mode:\n Minimum: 1\n Maximum: 10\n Default: 3\n","title":"DPD probe interval defines an interval for DPD probes (in seconds)"}}}],"description":"Dead peer detection (DPD) is a method that allows detection of unreachable internet key excahnge (IKE) peers. Any changes affects all IPSec VPN sessions consuming this profile.","title":"Dead peer detection (DPD) profile"},"OrgInfo":{"description":"Organization ID and role, predefined for a particular type of VMware support.","title":"Organization ID and role","required":["org_id","org_role"],"x-vmw-nsx-module":"ApplianceModes","type":"object","properties":{"org_id":{"type":"string","description":"Organization ID, connected to a predefined role of a VMware support.","title":"Org ID"},"org_role":{"type":"string","description":"Predefined role of a VMware support.","title":"Org role"}}},"FirewallRuleList":{"x-vmw-nsx-module":"Firewall","required":["rules"],"type":"object","properties":{"rules":{"items":{"$ref":"#/definitions/FirewallRule"},"type":"array","description":"List of firewall rules in the section. Only homogenous rules are supported.","maxItems":1000,"title":"List of the firewall rules"}}},"IPsecVPNIKESessionSummary":{"x-vmw-nsx-module":"VPNStatistics","type":"object","description":"IPSec VPN session status summary, gives total, failed, degraded and established IPSec VPN sessions.","properties":{"established_sessions":{"readOnly":true,"format":"int64","type":"integer","description":"Number of established sessions.","title":"Established sessions"},"total_sessions":{"readOnly":true,"format":"int64","type":"integer","description":"Total sessions configured.","title":"Total sessions"},"failed_sessions":{"readOnly":true,"format":"int64","type":"integer","description":"Number of failed sessions.","title":"Failed sessions"},"degraded_sessions":{"readOnly":true,"format":"int64","type":"integer","description":"Number of degraded sessions.","title":"Degraded sessions"}},"title":"IPSec VPN session status summary"},"SearchResponse":{"x-vmw-nsx-module":"Search","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"Search","type":"object","properties":{"results":{"items":{"type":"object"},"readOnly":true,"type":"array","description":"List of records matching the search query.","title":"Search results"}}}],"description":"Search response","title":"SearchResponse"},"PortConnectionLogicalSwitch":{"x-vmw-nsx-module":"PortConnection","allOf":[{"$ref":"#/definitions/PortConnectionEntity"},{"x-vmw-nsx-module":"PortConnection","type":"object","properties":{"vm_ports_states":{"items":{"$ref":"#/definitions/LogicalPortState"},"readOnly":true,"type":"array","description":"States of Logical Ports that are attached to a VIF/VM","title":"States of Logical Ports that are attached to a VIF/VM"},"vm_ports":{"items":{"$ref":"#/definitions/LogicalPort"},"readOnly":true,"type":"array","description":"Logical Ports that are attached to a VIF/VM","title":"Logical Ports that are attached to a VIF/VM"},"vm_vnics":{"items":{"$ref":"#/definitions/VirtualNetworkInterface"},"readOnly":true,"type":"array","description":"Virutal Network Interfaces that are attached to the Logical Ports","title":"Virutal Network Interfaces that are attached to the Logical Ports"},"router_ports":{"items":{"$ref":"#/definitions/LogicalPort"},"readOnly":true,"type":"array","description":"Logical Ports that are attached to a router","title":"Logical Ports that are attached to a router"}}}],"description":"Port Connection Logical Switch Entity","title":"Port Connection Logical Switch Entity"},"FireWallServiceAssociationListResult":{"x-vmw-nsx-module":"GroupingObjectsProviders","allOf":[{"$ref":"#/definitions/ServiceAssociationListResult"},{"x-vmw-nsx-module":"GroupingObjectsProviders","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/FirewallRule"},"readOnly":true,"type":"array","description":"Firewall rule list result with pagination support.","title":"Firewall rule list result"}}}]},"NSXProfileReference":{"x-vmw-nsx-module":"ServiceConfig","allOf":[{"$ref":"#/definitions/ResourceReference"},{"required":["profile_type"],"x-vmw-nsx-module":"ServiceConfig","type":"object","properties":{"profile_type":{"description":"Profile type of the ServiceConfig","enum":["FirewallSessionTimerProfile","FirewallCpuMemThresholdsProfile","GiServiceProfile","FirewallFloodProtectionProfile","FirewallDnsProfile","LatencyStatProfile","SHAProfile","IpDiscoverySwitchingUpmProfile","SystemHealthPluginProfile","GeneralSecuritySettingsProfile","IpfixSwitchUpmProfile","IpfixCollectorUpmProfile","PaceHostConfigProfile","CommonAgentHostConfigProfile"],"type":"string"}}}],"description":"It is a reference to any NSX profile. It comprise of NSX profile type\neg. DFWCPUProfile, CentralConfigProfile etc. and id of profile i.e. target_id\n","title":"Reference of single NSX profile which need to added in service config profiles"},"UpgradeChecksExecutionStatus":{"x-vmw-nsx-module":"Upgrade","type":"object","description":"Execution status of pre/post-upgrade checks","properties":{"status":{"readOnly":true,"enum":["NOT_STARTED","IN_PROGRESS","ABORTING","ABORTED","COMPLETED"],"type":"string","description":"Status of execution of pre/post-upgrade checks","title":"Status of execution of pre/post-upgrade checks"},"node_with_issues_count":{"description":"Number of nodes which generated failures or warnings in last execution\nof pre/post-upgrade checks. This field has been deprecated. Please use\nfailure_count instead.\n","format":"int32","title":"Number of nodes with failures/warnings","x-deprecated":true,"readOnly":true,"type":"integer"},"details":{"readOnly":true,"type":"string","description":"Details about current execution of pre/post-upgrade checks","title":"Details about current execution of pre/post-upgrade checks"},"failure_count":{"readOnly":true,"format":"int32","type":"integer","description":"Total count of generated failures or warnings in last execution of\npre/post-upgrade checks\n","title":"Failure count"},"start_time":{"type":"integer","description":"Time (in milliseconds since epoch) when the execution of\npre/post-upgrade checks started\n","format":"int64"},"end_time":{"type":"integer","description":"Time (in milliseconds since epoch) when the execution of\npre/post-upgrade checks completed\n","format":"int64"}},"title":"Execution status of pre/post-upgrade checks"},"LbSslProtocolInfo":{"description":"SSL protocol","title":"SSL protocol","required":["is_default","is_secure","protocol"],"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"is_default":{"type":"boolean","description":"Default SSL protocol flag","title":"Default SSL protocol flag"},"is_secure":{"type":"boolean","description":"Secure/insecure SSL protocol flag","title":"Secure/insecure SSL protocol flag"},"protocol":{"description":"SSL protocol","enum":["SSL_V2","SSL_V3","TLS_V1","TLS_V1_1","TLS_V1_2"],"type":"string"}}},"IdfwVirtualMachineCondition":{"description":"Status of the Identity Firewall compute collection's VM.","title":"IDFW VM Status.","required":["status"],"x-vmw-nsx-module":"IdentityFirewall","type":"object","properties":{"status":{"enum":["UNKNOWN","UP","DOWN","VM_TOOLS_NOT_INSTALLED","IDFW_NOT_SUPPORTED","DFW_DISABLED","IDFW_DISABLED"],"type":"string","description":"VM IDFW Status.","title":"VM IDFW Status."},"status_detail":{"type":"string","description":"IDFW compute collection's VM condition.","title":"IDFW VM condition."}}},"ExtendedSolutionConfig":{"x-vmw-nsx-module":"Nxgi","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"Nxgi","type":"object","properties":{"service_id":{"readOnly":true,"type":"string","description":"The service to which the solution config belongs.","title":"Service Id"},"attributes":{"items":{"$ref":"#/definitions/Attribute"},"type":"array","description":"List of attributes specific to a partner which needs to be passed to host.","maxItems":128,"title":"Servcie attributes"}}}],"description":"Extended Solution Config would contain Vendor specific information required for NXGI partner Service VM.","title":"Extended Solution Configuration Info"},"SIAggregatedDataCounterEx":{"x-vmw-nsx-module":"ServiceInsertionVMDeployment","allOf":[{"$ref":"#/definitions/SIAggregatedDataCounter"},{"x-vmw-nsx-module":"ServiceInsertionVMDeployment","type":"object","properties":{"mac_learning":{"$ref":"#/definitions/SIMacLearningCounters"},"dropped_by_security_packets":{"$ref":"#/definitions/SIPacketsDroppedBySecurity"}}}]},"GlobalConfigs":{"x-vmw-nsx-module":"GlobalConfigs","allOf":[{"$ref":"#/definitions/ManagedResource"},{"required":["resource_type"],"discriminator":"resource_type","x-vmw-nsx-module":"GlobalConfigs","type":"object","properties":{"resource_type":{"description":"Valid Global configuration types","enum":["SwitchingGlobalConfig","RoutingGlobalConfig","OperationCollectorGlobalConfig","FirewallGlobalConfig","EsxGlobalOpaqueConfig","SecurityGlobalConfig","FipsGlobalConfig","FederationGlobalConfig","IdsGlobalConfig"],"type":"string"}}}],"description":"The GlobalConfigs is the base class for global configurations for\ndifferent types in a NSX domain.\n","title":"Abstract base type for Global configurations of different types"},"Csr":{"x-vmw-nsx-module":"CertificateManager","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"CertificateManager","required":["subject"],"type":"object","properties":{"key_size":{"default":4096,"readOnly":false,"type":"integer","description":"Size measured in bits of the public key used in a cryptographic algorithm.","format":"int64"},"pem_encoded":{"readOnly":true,"type":"string","description":"PEM encoded certificate data."},"algorithm":{"default":"RSA","readOnly":false,"enum":["RSA"],"type":"string","description":"Cryptographic algorithm (asymmetric) used by the public key for data encryption."},"is_ca":{"default":false,"type":"boolean","description":"Whether the CSR is for a CA certificate."},"subject":{"$ref":"#/definitions/Principal"}}}]},"ErrorResolverMetadata":{"x-vmw-nsx-module":"ErrorResolver","required":["error_id","entity_id"],"type":"object","description":"Error along with its metadata","properties":{"error_id":{"format":"int64","type":"integer","description":"The error id as reported by the entity where the error occurred.","title":"The error id as reported by the entity where the error occurred."},"system_metadata":{"$ref":"#/definitions/ErrorResolverSystemMetadata"},"entity_id":{"type":"string","description":"The entity/node UUID where the error has occurred.","title":"The entity/node UUID where the error has occurred."},"user_metadata":{"$ref":"#/definitions/ErrorResolverUserMetadata"}}},"IPSecVPNPolicySubnet":{"description":"Used to specify the local/peer subnets in IPSec VPN Policy rule.","title":"Subnet for IPSec Policy based VPN","required":["subnet"],"x-vmw-nsx-module":"IPSecVPN","type":"object","properties":{"subnet":{"description":"Subnet used in policy rule.","format":"ipv4-cidr-block","type":"string"}}},"IPSecVPNTransportStatus":{"x-vmw-nsx-module":"L2VPNStatistics","allOf":[{"$ref":"#/definitions/L2VPNTransportTunnelStatus"},{"x-vmw-nsx-module":"L2VPNStatistics","type":"object","properties":{"status":{"$ref":"#/definitions/IPSecVPNSessionStatus"}}}],"description":"Provides IPSec VPN session status.","title":"VPN Session status"},"ServiceInsertionServiceProfile":{"x-vmw-nsx-module":"ServiceInsertionCommonTypes","allOf":[{"$ref":"#/definitions/BaseServiceProfile"},{"required":["vendor_template_id"],"x-vmw-nsx-module":"ServiceInsertionCommonTypes","type":"object","properties":{"attributes":{"description":"List of attributes specific to a partner for which the service is created. These attributes are passed on to the partner appliance and are opaque to the NSX Manager. If a vendor template exposes configurables, then the values are specified here.","title":"Service profile attributes","items":{"$ref":"#/definitions/Attribute"},"readOnly":false,"maxItems":128,"type":"array"},"service_id":{"readOnly":true,"type":"string","description":"The service to which the service profile belongs.","title":"Service Id"},"redirection_action":{"description":"The redirection action represents if the packet is exclusively redirected to the service, or if a copy is forwarded to the service. The service insertion profile inherits the redirection action if already specified at the vendor template. However the service profile cannot overide the action specified at the vendor template.","title":"Redirection action","default":"PUNT","enum":["PUNT","COPY"],"readOnly":false,"type":"string"},"vendor_template_id":{"readOnly":false,"type":"string","description":"Id of the vendor template to be used by the servive profile.","title":"Vendor template id"}}}],"description":"Service profile represents a specialization of vendor template.","title":"Service Profile for a Service"},"QosSwitchingProfile":{"x-vmw-nsx-module":"QosSwitchingProfile","allOf":[{"$ref":"#/definitions/BaseSwitchingProfile"},{"x-vmw-nsx-module":"QosSwitchingProfile","type":"object","properties":{"shaper_configuration":{"minItems":0,"items":{"$ref":"#/definitions/QosBaseRateShaper"},"type":"array","maxItems":3},"class_of_service":{"description":"Class of service","title":"Class of service","default":0,"format":"int32","maximum":7,"minimum":0,"type":"integer"},"dscp":{"$ref":"#/definitions/Dscp"}}}]},"ComputeCollectionListResult":{"x-vmw-nsx-module":"InventoryCmObj","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"InventoryCmObj","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/ComputeCollection"},"type":"array","description":"Compute Collection list results","title":"Compute Collection list results"}}}],"description":"Compute Collection list result","title":"Compute Collection list result"},"NormalizedResourceListResult":{"x-vmw-nsx-module":"Normalization","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"Normalization","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/ResourceReference"},"type":"array","description":"Normalized resource list results","title":"Normalized resource list results"}}}],"description":"Paged Collection of normalized resources","title":"Paged Collection of normalized resources"},"ClusterNodeVMDeploymentRequestList":{"x-vmw-nsx-module":"ClusterNodeVMDeployment","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"ClusterNodeVMDeployment","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/ClusterNodeVMDeploymentRequest"},"type":"array","description":"Array of existing ClusterNodeVMDeploymentRequests\n","title":"Results"}}}],"description":"List of ClusterNodeVMDeploymentRequests","title":"ClusterNodeVMDeploymentRequest list"},"BasicAuthenticationScheme":{"x-vmw-nsx-module":"MISSING_MODULE","allOf":[{"$ref":"#/definitions/AuthenticationScheme"},{"x-vmw-nsx-module":"MISSING_MODULE","required":["username","scheme_name"],"type":"object","properties":{"username":{"type":"string","description":"User name to authenticate with","title":"User name to authenticate with"},"scheme_name":{"enum":["basic"],"type":"string","description":"Authentication scheme name","title":"Authentication scheme name"},"password":{"type":"string","description":"Password to authenticate with","title":"Password to authenticate with"}}}]},"MpMigrationData":{"x-vmw-nsx-module":"MPPolicyMigration","type":"object","description":"Contains manager and policy resource id.\n","properties":{"skip_failed_resources":{"default":false,"type":"boolean","description":"Default value is false. This value will indicate if there is error,\nskip the failed objects and proceed with next set of objects for MP to Policy promotion.\n","title":"Default value is false. This value will indicate if there is error,\nskip the failed objects and proceed with next set of objects for MP to Policy promotion.\n"},"setup_details":{"$ref":"#/definitions/SetupDetails"},"migration_data":{"items":{"$ref":"#/definitions/MPResource"},"type":"array","description":"migration data ( resource type and Ids ).","title":"migration data ( resource type and Ids )."},"mode":{"description":"Mode of MP2Policy migration","title":"Mode of MP2Policy migration","default":"CONSUMER","enum":["GENERIC","CONSUMER"],"readOnly":false,"type":"string"}},"title":"Contains manager and policy resource id.\n"},"LbAccessListControl":{"description":"LbAccessListControl is used to define how IP access list control can filter\nthe connections from clients.\n","title":"IP access list control to filter the connections from clients","required":["action","group_id"],"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"action":{"enum":["ALLOW","DROP"],"type":"string","description":"ALLOW means connections matching grouping object IP list are allowed\nand requests not matching grouping object IP list are dropped.\nDROP means connections matching grouping object IP list are dropped\nand requests not matching grouping object IP list are allowed.\n","title":"IP access list control action"},"group_id":{"type":"string","description":"The identifier of grouping object which defines the IP addresses or\nranges to match the client IP.\n","title":"Grouping object identifier"},"enabled":{"default":false,"type":"boolean","description":"The enabled flag indicates whether to enable access list control option.\nIt is false by default.\n","title":"Whether to enable access list control option"}}},"IpfixCollectorConfigListResult":{"x-vmw-nsx-module":"Ipfix","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"Ipfix","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/IpfixCollectorConfig"},"readOnly":true,"type":"array","description":"IPFIX Collector Config","title":"IPFIX Collector Config"}}}],"description":"List of IPFIX Collector Configs","title":"List of IPFIX Collector Configs"},"SupportBundleRequest":{"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"remote_file_server":{"$ref":"#/definitions/SupportBundleRemoteFileServer"},"dynamic_content_filters":{"default":["ALL"],"items":{"type":"string","description":"Support bundle dynamic content filter allowed values, for example, NAPP:SERVICE:PLATFORM_SERVICES"},"type":"array","description":"List of dynamic content filters that specify additional content to include in the support bundle. The list of available filters available depends on your NSX-T deployment and can be determined by invoking the GET /api/v1/adminstration/support-bundles/dynamic-content-filters NSX API. For example, if NSX Intelligence is deployed, filters for collecting specific information about services are available.","title":"List of content filters that decide the additional content that go into the support bundle"},"content_filters":{"description":"Bundle should include content of specified type","title":"Bundle should include content of specified type","default":["DEFAULT"],"items":{"description":"Support bundle content filter allowed values","enum":["ALL","DEFAULT"],"type":"string"},"minItems":1,"type":"array"},"log_age_limit":{"format":"int64","minimum":1,"type":"integer","description":"Include log files with modified times not past the age limit in days","title":"Include log files with modified times not past the age limit in days"},"container_nodes":{"minItems":1,"items":{"$ref":"#/definitions/SupportBundleContainerNode"},"type":"array","description":"List of container clusters and their nodes requiring support bundle collection","title":"List of container clusters and their nodes requiring support bundle collection"},"nodes":{"minItems":1,"items":{"type":"string"},"type":"array","description":"List of cluster/fabric node UUIDs processed in specified order","title":"List of cluster/fabric node UUIDs processed in specified order"}}},"UserInfo":{"x-vmw-nsx-module":"AAA","type":"object","description":"Authenticated User Info","properties":{"user_name":{"readOnly":true,"type":"string","description":"User Name","title":"User Name"},"roles":{"items":{"$ref":"#/definitions/NsxRole"},"readOnly":true,"type":"array","description":"Permissions","title":"Permissions"}},"title":"Authenticated User Info"},"ClusterGroupStatus":{"x-vmw-nsx-module":"Cluster","type":"object","description":"This type contains the attributes and status of a group.","properties":{"members":{"items":{"$ref":"#/definitions/ClusterGroupMemberStatus"},"readOnly":true,"type":"array","description":"Array of group members and their statuses","title":"Array of group members and their statuses"},"group_id":{"readOnly":true,"type":"string","description":"UUID of the group","title":"UUID of the group"},"leaders":{"items":{"$ref":"#/definitions/ClusterGroupServiceLeader"},"readOnly":true,"type":"array","description":"Array of group leaders and their attributes","title":"Array of group leaders and their attributes"},"group_status":{"readOnly":true,"enum":["STABLE","DEGRADED","UNSTABLE","UNAVAILABLE"],"type":"string","description":"Group status","title":"Group status"},"group_type":{"readOnly":true,"enum":["MANAGER","CONTROLLER","POLICY","HTTPS","DATASTORE","CLUSTER_BOOT_MANAGER","GLOBAL_MANAGER","ASYNC_REPLICATOR","MONITORING","IDPS_REPORTING","CORFU_NONCONFIG","CM-INVENTORY","MESSAGING-MANAGER"],"type":"string","description":"Type of the group","title":"Type of the group"}},"title":"Status of a group"},"PacketTypeAndCounter":{"x-vmw-nsx-module":"AggSvcL2Types","required":["counter","packet_type"],"type":"object","properties":{"counter":{"format":"int64","type":"integer","description":"The number of packets.","title":"The number of packets."},"packet_type":{"type":"string","description":"The type of the packets","title":"The type of the packets"}}},"WidgetItem":{"description":"Represents a reference to a widget that is held by a container or a multi-widget or a View.","title":"Widget held by MultiWidgetConfiguration or Container or a View","required":["widget_id"],"x-vmw-nsx-module":"NsxDashboard","type":"object","properties":{"rowspan":{"format":"int32","minimum":1,"type":"integer","description":"Represents the vertical span of the widget / container","title":"Vertical span"},"separator":{"default":false,"type":"boolean","description":"If true, separates this widget in a container.","title":"A separator after this widget"},"weight":{"default":10000,"format":"int32","type":"integer","description":"Determines placement of widget or container relative to other widgets and containers. The lower the weight, the higher it is in the placement order.","title":"Weightage or placement of the widget or container"},"span":{"description":"Represents the horizontal span of the widget / container.","format":"int32","title":"Horizontal span","maximum":12,"minimum":1,"type":"integer"},"widget_id":{"maxLength":255,"type":"string","description":"Id of the widget configuration that is held by a multi-widget or a container or a view.","title":"Id of the widget configuration"},"alignment":{"default":"LEFT","enum":["LEFT","RIGHT"],"type":"string","description":"Aligns widget either left or right.","title":"Alignment of widget inside container"},"label":{"$ref":"#/definitions/Label"}}},"SystemHealthAgentProfile":{"x-vmw-nsx-module":"SystemHealthAgent","allOf":[{"$ref":"#/definitions/ManagedResource"},{"required":["plugin_id","config"],"x-vmw-nsx-module":"SystemHealthAgent","type":"object","properties":{"enabled":{"type":"boolean","description":"The on-off switch of System Health Agent","title":"Profile Enablement Flag"},"plugin_id":{"type":"string","description":"The id of System Health Agent plugin","title":"Plugin id"},"config":{"type":"string","description":"The config content of System Health Agent","title":"Profile Content"},"type":{"description":"The type of System Health Agent.\nThe System Health Agent plugin associated with given plugin id has already defined the profile type.\nSo the backend can obtain the type by the plugin definition directly. Mark this field as optional.\nIf need to check the type value by given plugin id, please call /systemhealth/plugins/.\n","enum":["COMPUTE","STORAGE","NETWORK","HYPERBUS","NCP","NODEAGENT","VSAN","TNAGENT","UPLINK"],"type":"string"}}}],"description":"Describes a profile to define a kind of system health agent.\n","title":"System Health Agent Profile Entity"},"DistributedVirtualPortgroup":{"x-vmw-nsx-module":"InventoryCmObj","allOf":[{"$ref":"#/definitions/VirtualPortgroup"},{"x-vmw-nsx-module":"InventoryCmObj","type":"object","properties":{"overall_status":{"readOnly":true,"enum":["RED","YELLOW","GREEN","GRAY"],"type":"string","description":"This parameters reflects the managed entity status of the portgroup\nas reported by VC.\n","title":"General status of the virtual portgroup"},"backing_type":{"readOnly":false,"type":"string","description":"For distributed virtual portgroup, backing type is standard.\nFor logical switch portgroup, the backing type is set to nsx.\n","title":"Backing type for portgroup"},"key":{"readOnly":false,"type":"string","description":"Generated UUID of the portgroup","title":"Generated UUID of the portgroup"}}}],"description":"Distributed virtual portgroup on a VC","title":"Distributed virtual portgroup on a VC"},"IPv4DhcpServer":{"description":"DHCP server to support IPv4 DHCP service. Properties defined at DHCP server\nlevel can be overridden by ip-pool or static-binding level properties.\n","title":"DHCP server to support IPv4 DHCP service","required":["dhcp_server_ip"],"x-vmw-nsx-module":"Dhcp","type":"object","properties":{"options":{"$ref":"#/definitions/DhcpOptions"},"monitor_ippool_usage":{"default":false,"type":"boolean","description":"Enable or disable monitoring of DHCP ip-pools usage. When enabled, system events are\ngenerated when pool usage exceeds the configured thresholds.\nSystem events can be viewed in REST API /api/v2/hpm/alarms\n","title":"Enable/disable monitoring DHCP ip-pool usage"},"dhcp_server_ip":{"description":"DHCP server ip in CIDR format.","format":"ipv4-cidr-block","type":"string"},"dns_nameservers":{"description":"Primary and secondary DNS server address to assign host. They can be\noverridden by ip-pool or static-binding level property.\n","title":"DNS ips","minItems":0,"items":{"description":"IPv4 address","format":"ipv4","type":"string"},"maxItems":2,"type":"array"},"domain_name":{"format":"hostname","type":"string","description":"Host name or prefix to be assigned to host. It can be overridden by\nip-pool or static-binding level property.\n","title":"Domain name"},"gateway_ip":{"description":"Gateway ip to be assigned to host. It can be overridden by ip-pool or\nstatic-binding level property.\n","format":"ipv4","type":"string"}}},"PrincipalIdentityList":{"x-vmw-nsx-module":"CertificateManager","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"CertificateManager","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/PrincipalIdentity"},"readOnly":false,"type":"array","description":"PrincipalIdentity list."}}}],"description":"PrincipalIdentity query result","title":"PrincipalIdentity query result"},"SecurityCertificate":{"x-vmw-nsx-module":"MISSING_MODULE","required":["pem_encoded"],"type":"object","properties":{"text":{"minLength":52,"readOnly":true,"type":"string","description":"X.509 certificate in text form","title":"X.509 certificate in text form"},"valid_from":{"readOnly":true,"type":"string","description":"The time when the certificate starts being valid","title":"The time when the certificate starts being valid"},"ssh_public_key":{"readOnly":true,"type":"string"},"valid_to":{"readOnly":true,"type":"string","description":"The time when the certificate stops being valid","title":"The time when the certificate stops being valid"},"pem_encoded":{"minLength":52,"readOnly":false,"type":"string","description":"The certificate must include the enclosing \"-----BEGIN CERTIFICATE-----\" and \"-----END CERTIFICATE-----\"","title":"PEM encoded X.509 certificate"}}},"Notification":{"x-vmw-nsx-module":"NfwConfig","type":"object","properties":{"notification_id":{"type":"string","description":"A string identifying feature_name.notification_name to indicate a notification watcher is interested in receiving notifications for the URI identified by the feature_name.notification_name.","title":"A string identifying feature_name.notification_name"},"uri_filters":{"uniqueItems":true,"items":{"type":"string"},"type":"array","description":"Optional list of URIs","title":"Optional list of URIs"}}},"InterfaceIgmpLocalGroupConfig":{"x-vmw-nsx-module":"LogicalRouterPorts","type":"object","description":"Interface IGMP[Internet Group Management Protocol] configuration parameters.\n","properties":{"igmp_local_join_groups":{"items":{"description":"IPv4 or IPv6 address","format":"ip","type":"string"},"type":"array","description":"IGMP join group manages the membership of hosts and routing devices in\nthe multicast group. Host will join the group by conveying its information\nthrough IGMP.\n","title":"List of local IGMP groups"}},"title":"Interface Igmp configuration"},"UpgradeProgressStatus":{"x-vmw-nsx-module":"MISSING_MODULE","type":"object","description":"Upgrade progress status","properties":{"upgrade_bundle_present":{"type":"boolean","description":"True if upgrade bundle is present","title":"True if upgrade bundle is present"},"last_upgrade_step_status":{"type":"object","description":"Status of last upgrade step","title":"Status of last upgrade step"},"upgrade_metadata":{"type":"object","description":"Meta info of upgrade","title":"Meta info of upgrade"}},"title":"Upgrade progress status"},"CpuCoreConfigForEnhancedNetworkingStackSwitch":{"description":"Non Uniform Memory Access (NUMA) nodes and Logical cpu cores (Lcores) per NUMA node configuration for Enhanced Networking Stack enabled HostSwitch.","title":"Enhanced Networking Stack CPU configuration","required":["num_lcores","numa_node_index"],"x-vmw-nsx-module":"TransportNode","type":"object","properties":{"num_lcores":{"description":"Number of Logical cpu cores (Lcores) to be placed on a specified NUMA node","format":"int32","title":"Number of Logical cpu cores (Lcores) to be placed on a specified NUMA node","readOnly":false,"minimum":1,"type":"integer"},"numa_node_index":{"description":"Unique index of the Non Uniform Memory Access (NUMA) node","format":"int32","title":"Unique index of the Non Uniform Memory Access (NUMA) node","readOnly":false,"minimum":0,"type":"integer"}}},"MPPolicyPromotionState":{"description":"Provides information if system is currently going under mp policy promotion.\n","title":"Fetches MP Policy promotion state.\n","required":["mp_policy_promotion"],"x-vmw-nsx-module":"PolicyMigration","type":"object","properties":{"mp_policy_promotion":{"enum":["PROMOTION_IN_PROGRESS","CANCELLING_PROMOTION","PROMOTION_NOT_IN_PROGRESS","CANCEL_FAILED"],"type":"string","description":"Used to get the mp policy promotion state. If system is under mp to policy promotion, it will be PROMOTION_IN_PROGRESS else PROMOTION_NOT_IN_PROGRESS.State is CANCELLING_PROMOTION, if ongoing promotion is cancelled.","title":"MP Policy promotion state value."}}},"SubPool":{"x-vmw-nsx-module":"EdgeClusters","type":"object","properties":{"usage_percentage":{"readOnly":true,"type":"number","description":"Percentage utlization of sub-pool based on the number of services\nconfigured and the hard limits, if any.\n","title":"Percentage utlization of sub-pool"},"remaining_credit_number":{"readOnly":true,"format":"int32","type":"integer","description":"Credits remaining on the sub-pool that can be used to deploy services of\ncorresponding sub-pool type.\n","title":"Remaining credit number of the sub-pool"},"sub_pool_type":{"readOnly":true,"type":"string","description":"Type of the sub-pool configured on edge node.","title":"Sub-pool Type"}}},"NSAttributesData":{"x-vmw-nsx-module":"NSProfile","allOf":[{"$ref":"#/definitions/ManagedResource"},{"required":["datatype","value","key"],"x-vmw-nsx-module":"NSProfile","type":"object","properties":{"datatype":{"enum":["STRING"],"type":"string","description":"Data type of attribute/sub attribute key","title":"Data type of attribute/sub attribute key"},"attribute_source":{"enum":["SYSTEM","CUSTOM"],"type":"string","description":"Attribute is predefined or custom","title":"Attribute is predefined or custom"},"value":{"description":"Multiple attribute/sub attribute values can be specified\nas elements of array.\n","title":"value for attribute/sub attribute key","minItems":1,"items":{"type":"string"},"uniqueItems":true,"type":"array"},"key":{"type":"string","description":"NSProfile attribute/sub attribute keys.\n","title":"Key for attribute/sub attribute"},"description":{"type":"string","description":"Description for NSProfile attributes","title":"Description for NSProfile attributes"}}}],"description":"Attributes/sub-attributes data holder structure for NSProfile","title":"Attributes/sub-attributes data holder structure for NSProfile"},"NSGroupListResult":{"x-vmw-nsx-module":"NSGroup","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"NSGroup","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/NSGroup"},"type":"array","description":"NSGroup list results","title":"NSGroup list results"}}}],"description":"Paged Collection of NSGroups","title":"Paged Collection of NSGroups"},"DirectoryOrgUnitListResults":{"x-vmw-nsx-module":"DirectoryService","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"DirectoryService","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/DirectoryOrgUnit"},"type":"array","description":"List of Organization Units","maxItems":500,"title":"List of Organization Units"}}}],"description":"List of organization units","title":"List of organization units"},"WidgetConfiguration":{"x-vmw-nsx-module":"NsxDashboard","allOf":[{"$ref":"#/definitions/ManagedResource"},{"required":["resource_type"],"discriminator":"resource_type","x-vmw-nsx-module":"NsxDashboard","type":"object","properties":{"feature_set":{"$ref":"#/definitions/FeatureSet"},"plot_configs":{"items":{"$ref":"#/definitions/WidgetPlotConfiguration"},"type":"array","description":"List of plotting configuration for a given widget. Widget plotting configurations which are common across all the widgets types should be define here.","title":"List of plotting configuration for a given widget."},"default_filter_value":{"items":{"$ref":"#/definitions/DefaultFilterValue"},"type":"array","description":"Default filter values to be passed to datasources. This will be used when the report is requested without filter values.","title":"Default filter value to be passed to datasources"},"rowspan":{"format":"int32","minimum":1,"type":"integer","description":"Represents the vertical span of the widget / container. 1 Row span is equal to 20px.","title":"Vertical span"},"display_name":{"maxLength":255,"type":"string","description":"Title of the widget. If display_name is omitted, the widget will be shown without a title.","title":"Widget Title"},"datasources":{"minItems":0,"items":{"$ref":"#/definitions/Datasource"},"type":"array","description":"The 'datasources' represent the sources from which data will be fetched. Currently, only NSX-API is supported as a 'default' datasource. An example of specifying 'default' datasource along with the urls to fetch data from is given at 'example_request' section of 'CreateWidgetConfiguration' API.","title":"Array of Datasource Instances with their relative urls"},"weight":{"format":"int32","type":"integer","description":"Specify relavite weight in WidgetItem for placement in a view. Please see WidgetItem for details.","x-deprecated":true,"title":"Weightage or placement of the widget or container"},"footer":{"$ref":"#/definitions/Footer"},"shared":{"type":"boolean","description":"Please use the property 'shared' of View instead of this. The widgets of a shared view are visible to other users.","x-deprecated":true,"title":"Visiblity of widgets to other users"},"span":{"description":"Represents the horizontal span of the widget / container.","format":"int32","title":"Horizontal span","maximum":12,"minimum":1,"type":"integer"},"icons":{"items":{"$ref":"#/definitions/Icon"},"type":"array","description":"Icons to be applied at dashboard for widgets and UI elements.","title":"Icons"},"is_drilldown":{"default":false,"type":"boolean","description":"Set to true if this widget should be used as a drilldown.","title":"Set as a drilldown widget"},"filter":{"type":"string","description":"Id of filter widget for subscription, if any. Id should be a valid id of an existing filter widget. Filter widget should be from the same view. Datasource URLs should have placeholder values equal to filter alias to accept the filter value on filter change. This field is deprecated instead use 'filters' property.","x-deprecated":true,"title":"Id of filter widget for subscription"},"show_header":{"type":"boolean","description":"If the value of this field is set to true then card header will be displayed otherwise only card will be displayed without header.","title":"This decides to show the container header or not."},"resource_type":{"description":"Supported visualization types are LabelValueConfiguration, DonutConfiguration, GridConfiguration, StatsConfiguration, MultiWidgetConfiguration, GraphConfiguration, ContainerConfiguration, CustomWidgetConfiguration, CustomFilterWidgetConfiguration, TimeRangeDropdownFilterWidgetConfiguration, SpacerWidgetConfiguration, LegendWidgetConfiguration and DropdownFilterWidgetConfiguration.","title":"Widget visualization type","enum":["LabelValueConfiguration","DonutConfiguration","MultiWidgetConfiguration","ContainerConfiguration","StatsConfiguration","GridConfiguration","GraphConfiguration","CustomWidgetConfiguration","CustomFilterWidgetConfiguration","TimeRangeDropdownFilterWidgetConfiguration","DropdownFilterWidgetConfiguration","SpacerWidgetConfiguration","LegendWidgetConfiguration"],"readOnly":true,"maxLength":255,"type":"string"},"filters":{"items":{"type":"string"},"type":"array","description":"A List of filter applied to this widget configuration. This will be used to identify the filters applied to this widget.","title":"A List of filter ids applied to this widget configuration"},"drilldown_id":{"maxLength":255,"type":"string","description":"Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget.","title":"Id of drilldown widget"},"filter_value_required":{"default":true,"type":"boolean","description":"Flag to indicate that widget will continue to work without filter value. If this flag is set to false then default_filter_value is manadatory.","title":"Flag to indicate if filter value is necessary"},"legend":{"$ref":"#/definitions/Legend"},"condition":{"maxLength":1024,"type":"string","description":"If the condition is met then the widget will be displayed to UI. If no condition is provided, then the widget will be displayed unconditionally.","title":"Expression for evaluating condition"}}}],"description":"Describes the configuration of a widget to be displayed on the dashboard. WidgetConfiguration is a base type that provides attributes of a widget in-general.","title":"Dashboard Widget Configuration"},"VirtualNetworkInterfaceListResult":{"x-vmw-nsx-module":"Inventory","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"Inventory","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/VirtualNetworkInterface"},"type":"array","description":"VirtualNetworkInterface list results","title":"VirtualNetworkInterface list results"}}}]},"DSRule":{"x-vmw-nsx-module":"DistributedServices","allOf":[{"$ref":"#/definitions/EmbeddedResource"},{"x-vmw-nsx-module":"DistributedServices","required":["action"],"type":"object","properties":{"is_default":{"readOnly":true,"type":"boolean","description":"Flag to indicate whether rule is default.","title":"Default rule"},"direction":{"description":"Rule direction in case of stateless distributed service rules. This will only considered if section level parameter is set to stateless. Default to IN_OUT if not specified.","title":"Rule direction","default":"IN_OUT","enum":["IN","OUT","IN_OUT"],"readOnly":false,"type":"string"},"rule_tag":{"readOnly":false,"maxLength":32,"type":"string","description":"User level field which will be printed in CLI and packet logs.","title":"Tag"},"ip_protocol":{"description":"Type of IP packet that should be matched while enforcing the rule.","title":"IPv4 vs IPv6 packet type","default":"IPV4_IPV6","enum":["IPV4","IPV6","IPV4_IPV6"],"readOnly":false,"type":"string"},"notes":{"readOnly":false,"maxLength":2048,"type":"string","description":"User notes specific to the rule.","title":"Notes"},"applied_tos":{"description":"List of object where rule will be enforced. The section level field overrides this one. Null will be treated as any.","title":"AppliedTo List","items":{"$ref":"#/definitions/ResourceReference"},"readOnly":false,"maxItems":128,"type":"array"},"logged":{"default":false,"readOnly":false,"type":"boolean","description":"Flag to enable packet logging. Default is disabled.","title":"Enable logging flag"},"disabled":{"default":false,"readOnly":false,"type":"boolean","description":"Flag to disable rule. Disabled will only be persisted but never provisioned/realized.","title":"Rule enable/disable flag"},"sources":{"description":"List of sources. Null will be treated as any.","title":"Source List","items":{"$ref":"#/definitions/ResourceReference"},"readOnly":false,"maxItems":128,"type":"array"},"action":{"readOnly":false,"enum":["ALLOW","DROP","REJECT","REDIRECT","DO_NOT_REDIRECT","DETECT","ALLOW_CONTINUE","DETECT_PREVENT"],"type":"string","description":"Action enforced on the packets which matches the distributed service rule. Currently DS Layer supports below actions. ALLOW - Forward any packet when a rule with this action gets a match (Used by Firewall). DROP - Drop any packet when a rule with this action gets a match. Packets won't go further(Used by Firewall). REJECT - Terminate TCP connection by sending TCP reset for a packet when a rule with this action gets a match (Used by Firewall). REDIRECT - Redirect any packet to a partner appliance when a rule with this action gets a match (Used by Service Insertion). DO_NOT_REDIRECT - Do not redirect any packet to a partner appliance when a rule with this action gets a match (Used by Service Insertion). DETECT - Detect IDS Signatures. ALLOW_CONTINUE - Allows rules to jump from this rule. Action on matching rules in the destination category will decide next step. Application is default destination until new categories are supported to jump to. DETECT_PREVENT - Detect and Prevent IDS Signatures.","title":"Action"},"priority":{"readOnly":true,"format":"int64","type":"integer","description":"Priority of the rule.","title":"Rule priority"},"sources_excluded":{"default":false,"readOnly":false,"type":"boolean","description":"Negation of the source.","title":"Negation of source"},"destinations_excluded":{"default":false,"readOnly":false,"type":"boolean","description":"Negation of the destination.","title":"Negation of destination"},"destinations":{"description":"List of the destinations. Null will be treated as any.","title":"Destination List","items":{"$ref":"#/definitions/ResourceReference"},"readOnly":false,"maxItems":128,"type":"array"}}}]},"TraceflowObservationDropped":{"x-vmw-nsx-module":"Traceflow","allOf":[{"$ref":"#/definitions/TraceflowObservation"},{"x-vmw-nsx-module":"Traceflow","type":"object","properties":{"nat_rule_id":{"readOnly":true,"format":"int64","type":"integer","description":"This field is specified when the traceflow packet matched a NAT rule.\n","title":"The ID of the NAT rule that was applied to drop the traceflow packet"},"reason":{"readOnly":true,"enum":["ARP_FAIL","BFD","BROADCAST","DHCP","DLB","FW_RULE","GENEVE","GRE","IFACE","IP","IP_REASS","IPSEC","IPSEC_VTI","L2VPN","L4PORT","LB","LROUTER","LSERVICE","LSWITCH","MANAGEMENT","MD_PROXY","NAT","RTEP_TUNNEL","ND_NS_FAIL","NEIGH","NO_EIP_FOUND","NO_EIP_ASSOCIATION","NO_ENI_FOR_IP","NO_ENI_FOR_LIF","NO_ROUTE","NO_ROUTE_TABLE_FOUND","NO_UNDERLAY_ROUTE_FOUND","NOT_VDR_DOWNLINK","NO_VDR_FOUND","NO_VDR_ON_HOST","NOT_VDR_UPLINK","SERVICE_INSERT","SPOOFGUARD","TTL_ZERO","TUNNEL","VLAN","VXLAN","VXSTT","VMC_NO_RESPONSE","WRONG_UPLINK","FW_STATE","UNKNOWN"],"type":"string","description":"The reason traceflow packet was dropped","title":"The reason traceflow packet was dropped"},"jumpto_rule_id":{"readOnly":true,"format":"int64","type":"integer","description":"This field is specified when the traceflow packet matched a jump-to rule.\n","title":"The ID of the jump-to rule that was applied to the traceflow packet"},"lport_id":{"readOnly":true,"type":"string","description":"The id of the logical port at which the traceflow packet was dropped","title":"The id of the logical port at which the traceflow packet was dropped"},"lport_name":{"readOnly":true,"type":"string","description":"The name of the logical port at which the traceflow packet was dropped","title":"The name of the logical port at which the traceflow packet was dropped"},"acl_rule_id":{"readOnly":true,"format":"int64","type":"integer","description":"This field is specified when the traceflow packet matched a L3 firewall rule.\n","title":"The id of the L3 firewall rule that was applied to drop the traceflow packet"},"arp_fail_reason":{"readOnly":true,"enum":["ARP_UNKNOWN","ARP_TIMEOUT","ARP_CPFAIL","ARP_FROMCP","ARP_PORTDESTROY","ARP_TABLEDESTROY","ARP_NETDESTROY"],"type":"string","description":"This field specifies the ARP fails reason ARP_TIMEOUT - ARP failure due to query control plane timeout ARP_CPFAIL - ARP failure due post ARP query message to control plane failure ARP_FROMCP - ARP failure due to deleting ARP entry from control plane ARP_PORTDESTROY - ARP failure due to port destruction ARP_TABLEDESTROY - ARP failure due to ARP table destruction ARP_NETDESTROY - ARP failure due to overlay network destruction","title":"The detailed drop reason of ARP traceflow packet"},"l2_rule_id":{"readOnly":true,"format":"int64","type":"integer","description":"This field is specified when the traceflow packet matched a l2 rule.\n","title":"The ID of the l2 rule that was applied to the traceflow packet"}}}]},"NatRuleList":{"x-vmw-nsx-module":"Nat","required":["rules"],"type":"object","properties":{"rules":{"items":{"$ref":"#/definitions/NatRule"},"type":"array","description":"Add new NatRules to the list in Bulk creation.\n","maxItems":128,"title":"NAT rules list"}}},"ClusterNodeInfo":{"x-vmw-nsx-module":"ClusterManagement","type":"object","properties":{"status":{"readOnly":true,"enum":["JOINING","JOINED","REMOVING","REMOVED"],"type":"string","description":"Node clustering status","title":"Node clustering status"},"msg_clients":{"items":{"$ref":"#/definitions/NodeMessagingClientInfo"},"type":"array","description":"Messaging client of all entities","title":"Messaging client of all entities"},"node_uuid":{"readOnly":true,"type":"string","description":"Unique identifier of this node","title":"Unique identifier of this node"},"display_name":{"type":"string","description":"The display name of this node","title":"The display name of this node"},"entities":{"items":{"$ref":"#/definitions/NodeEntityInfo"},"type":"array","description":"Service endpoint of all entities","title":"Service endpoint of all entities"},"certificates":{"items":{"$ref":"#/definitions/NodeCertificateInfo"},"type":"array","description":"Certificate and thumbprint of all entities","title":"Certificate and thumbprint of all entities"},"api_listen_addr":{"$ref":"#/definitions/ServiceEndpoint"},"fqdn":{"type":"string","description":"The fqdn of this node","title":"The fqdn of this node"},"appliance_connection_info":{"$ref":"#/definitions/ServiceEndpoint"},"control_plane_listen_addr":{"$ref":"#/definitions/ServiceEndpoint"}}},"VirtualSwitch":{"x-vmw-nsx-module":"InventoryCmObj","allOf":[{"$ref":"#/definitions/DiscoveredResource"},{"x-vmw-nsx-module":"InventoryCmObj","type":"object","properties":{"cm_local_id":{"readOnly":true,"type":"string","description":"ID of the virtual switch in compute manager","title":"ID of the virtual switch in compute manager"},"external_id":{"readOnly":true,"type":"string","description":"External id of the virtual switch","title":"External id of the virtual switch"},"origin_type":{"readOnly":true,"type":"string","description":"Switch type like VmwareDistributedVirtualSwitch","title":"Switch type like VmwareDistributedVirtualSwitch"},"origin_id":{"readOnly":true,"type":"string","description":"ID of the compute manager where this virtual switch is discovered.\n","title":"ID of the compute manager"}}}],"description":"Virtual switch on a compute manager","title":"Virtual switch on a compute manager"},"RestoreStep":{"x-vmw-nsx-module":"ClusterRestore","type":"object","description":"Restore step info","properties":{"status":{"$ref":"#/definitions/PerStepRestoreStatus"},"step_number":{"readOnly":true,"format":"int64","type":"integer","description":"Restore step number","title":"Restore step number"},"description":{"readOnly":true,"type":"string","description":"Restore step description","title":"Restore step description"},"value":{"readOnly":true,"type":"string","description":"Restore step value","title":"Restore step value"}},"title":"Restore step info"},"NsxtSiteToAviMapping":{"x-vmw-nsx-module":"Migration","type":"object","description":"Details about mapping of NSX-T site to AVI LB endpoint.","properties":{"avi_lb_endpoint":{"$ref":"#/definitions/AviEndPoint"},"federation_site_id":{"readOnly":true,"type":"string","description":"Federation NSX-T site id.","title":"Federation NSX-T site id"}},"title":"Details about mapping of NSX-T site to AVI LB endpoint"},"DSSectionQueryParameters":{"x-vmw-nsx-module":"DistributedServices","type":"object","description":"Section query parameters","properties":{"cascade":{"default":false,"type":"boolean","description":"Flag to cascade delete of this object to all it's child objects.","title":"Flag to cascade delete of this object to all it's child objects."}},"title":"Section query parameters"},"LogicalRouterPort":{"x-vmw-nsx-module":"LogicalRouterPorts","allOf":[{"$ref":"#/definitions/ManagedResource"},{"discriminator":"resource_type","x-vmw-nsx-module":"LogicalRouterPorts","required":["logical_router_id","resource_type"],"type":"object","properties":{"logical_router_id":{"type":"string","description":"Identifier for logical router on which this port is created","title":"Identifier for logical router on which this port is created"},"service_bindings":{"items":{"$ref":"#/definitions/ServiceBinding"},"type":"array","description":"Service Bindings","title":"Service Bindings"},"resource_type":{"description":"LogicalRouterUpLinkPort is allowed only on TIER0 logical router.\n It is the north facing port of the logical router.\nLogicalRouterLinkPortOnTIER0 is allowed only on TIER0 logical router.\n This is the port where the LogicalRouterLinkPortOnTIER1 of TIER1 logical router connects to.\nLogicalRouterLinkPortOnTIER1 is allowed only on TIER1 logical router.\n This is the port using which the user connected to TIER1 logical router for upwards connectivity via TIER0 logical router.\n Connect this port to the LogicalRouterLinkPortOnTIER0 of the TIER0 logical router.\nLogicalRouterDownLinkPort is for the connected subnets on the logical router.\nLogicalRouterLoopbackPort is a loopback port for logical router component\n which is placed on chosen edge cluster member.\nLogicalRouterIPTunnelPort is a IPSec VPN tunnel port created on\n logical router when route based VPN session configured.\nLogicalRouterCentralizedServicePort is allowed only on Active/Standby TIER0 and TIER1\n logical router. Port can be connected to VLAN or overlay logical switch.\n Unlike downlink port it does not participate in distributed routing and hosted\n on all edge cluster members associated with logical router.\n Stateful services can be applied on this port.\n","enum":["LogicalRouterUpLinkPort","LogicalRouterDownLinkPort","LogicalRouterLinkPortOnTIER0","LogicalRouterLinkPortOnTIER1","LogicalRouterLoopbackPort","LogicalRouterIPTunnelPort","LogicalRouterCentralizedServicePort"],"type":"string"}}}]},"CapacityThresholdList":{"x-vmw-nsx-module":"CapacityDashboard","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"CapacityDashboard","required":["capacity_thresholds"],"type":"object","properties":{"capacity_thresholds":{"items":{"$ref":"#/definitions/CapacityThreshold"},"type":"array","description":"List of capacity thresholds for NSX Objects","title":"List of capacity thresholds for NSX Objects"}}}]},"ControllerNodeAggregateInfo":{"x-vmw-nsx-module":"ClusterManagement","allOf":[{"$ref":"#/definitions/BaseNodeAggregateInfo"},{"x-vmw-nsx-module":"ClusterManagement","type":"object","properties":{"role_config":{"$ref":"#/definitions/ControllerClusterRoleConfig"}}}]},"ServiceInstanceHealthStatus":{"x-vmw-nsx-module":"ServiceInsertionVMDeployment","type":"object","description":"Health Status of a third party partner VM.","properties":{"is_sva_mux_incompatible":{"type":"boolean","description":"Protocol version might be different in both Mux and SVA.","title":"Flag is true when Mux and SVA are incompatible"},"connect_timestamp":{"type":"string","description":"Latest timestamp when mux was connected to SVA.","title":"Timestamp when mux was connected to SVA"},"mux_incompatible_version":{"type":"string","description":"Mux version when Mux and SVA are incompatible","title":"Mux incompatible version"},"solution_version":{"type":"string","description":"Version of third party partner solution application.","title":"Solution version of partner application"},"sync_time":{"type":"string","description":"Latest timestamp when health status is received.","title":"Health status timestamp"},"solution_status":{"type":"string","description":"Status of third party partner solution application.","title":"Third party partner solution status"},"is_stale":{"readOnly":true,"type":"boolean","description":"The parameter is set if the last received health status is older\nthan the predefined interval.\n","title":"Flag is true when health status is stale"},"mux_connected_status":{"type":"string","description":"Status of multiplexer which forwards the events from guest virtual machines to the partner appliance.","title":"Context Multiplexer Status"}},"title":"Service instance health status"},"BaseFirewallProfile":{"x-vmw-nsx-module":"FirewallProfile","allOf":[{"$ref":"#/definitions/ManagedResource"},{"discriminator":"resource_type","x-vmw-nsx-module":"FirewallProfile","required":["resource_type"],"type":"object","properties":{"resource_type":{"enum":["FirewallSessionTimerProfile","FirewallCpuMemThresholdsProfile","FirewallFloodProtectionProfile","FirewallDnsProfile","GeneralSecuritySettingsProfile"],"type":"string","description":"Resource type to use as profile type","title":"Resource type to use as profile type."}}}]},"NodeSummary":{"x-vmw-nsx-module":"Migration","allOf":[{"$ref":"#/definitions/Resource"},{"x-vmw-nsx-module":"Migration","type":"object","properties":{"node_count":{"readOnly":true,"format":"int32","type":"integer","description":"Number of nodes of the type and at the component version","title":"Count of nodes"},"type":{"readOnly":true,"type":"string","description":"Node type","title":"Node type"},"component_version":{"readOnly":true,"type":"string","description":"Component version","title":"Component version"},"upgrade_unit_subtype":{"readOnly":true,"enum":["RESOURCE","ACTION"],"type":"string","description":"UpgradeUnit sub type","title":"UpgradeUnit sub type"}}}]},"StatusCount":{"x-vmw-nsx-module":"Heatmap","type":"object","properties":{"status":{"enum":["UP","DOWN","DEGRADED","UNKNOWN"],"type":"string","description":"Roll-up status","title":"Roll-up status"},"degraded_count":{"format":"int32","type":"integer","description":"Degraded count","title":"Degraded count"},"down_count":{"format":"int32","type":"integer","description":"Down count","title":"Down count"},"up_count":{"format":"int32","type":"integer","description":"Up count","title":"Up count"}}},"DhcpStatistics":{"x-vmw-nsx-module":"AggSvcDhcp","required":["errors","releases","informs","timestamp","dhcp_server_id","nacks","offers","discovers","acks","declines","requests"],"type":"object","properties":{"errors":{"format":"int64","type":"integer","description":"The total number of DHCP errors","title":"The total number of DHCP errors"},"releases":{"format":"int64","type":"integer","description":"The total number of DHCP RELEASE packets","title":"The total number of DHCP RELEASE packets"},"informs":{"format":"int64","type":"integer","description":"The total number of DHCP INFORM packets","title":"The total number of DHCP INFORM packets"},"declines":{"format":"int64","type":"integer","description":"The total number of DHCP DECLINE packets","title":"The total number of DHCP DECLINE packets"},"dhcp_server_id":{"type":"string","description":"dhcp server uuid","title":"dhcp server uuid"},"nacks":{"format":"int64","type":"integer","description":"The total number of DHCP NACK packets","title":"The total number of DHCP NACK packets"},"offers":{"format":"int64","type":"integer","description":"The total number of DHCP OFFER packets","title":"The total number of DHCP OFFER packets"},"discovers":{"format":"int64","type":"integer","description":"The total number of DHCP DISCOVER packets","title":"The total number of DHCP DISCOVER packets"},"acks":{"format":"int64","type":"integer","description":"The total number of DHCP ACK packets","title":"The total number of DHCP ACK packets"},"timestamp":{"type":"integer","description":"timestamp of the statistics","format":"int64"},"requests":{"format":"int64","type":"integer","description":"The total number of DHCP REQUEST packets","title":"The total number of DHCP REQUEST packets"},"ip_pool_stats":{"items":{"$ref":"#/definitions/DhcpIpPoolUsage"},"type":"array","description":"The DHCP ip pool usage statistics","title":"The DHCP ip pool usage statistics"}}},"ClusterCertificateId":{"description":"Cluster Certificate ID","title":"Cluster Certificate ID","required":["certificate_id"],"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"certificate_id":{"type":"string","description":"Certificate ID","title":"Certificate ID"}}},"AggregatedDataCounterEx":{"x-vmw-nsx-module":"AggSvcL2Types","allOf":[{"$ref":"#/definitions/AggregatedDataCounter"},{"x-vmw-nsx-module":"AggSvcL2Types","type":"object","properties":{"mac_learning":{"$ref":"#/definitions/MacLearningCounters"},"dropped_by_security_packets":{"$ref":"#/definitions/PacketsDroppedBySecurity"}}}]},"LbSnatTranslation":{"discriminator":"type","x-vmw-nsx-module":"LoadBalancer","required":["type"],"type":"object","properties":{"type":{"description":"Load balancers may need to perform SNAT to ensure reverse traffic from\nthe server can be received and processed by them.\nThere are two modes:\nLbSnatAutoMap uses the load balancer interface IP and an\nephemeral port as the source IP and port of the server side connection.\nLbSnatIpPool allows user to specify one or more IP addresses\nalong with their subnet masks that should be used for SNAT while\nconnecting to any of the servers in the pool.\n","enum":["LbSnatAutoMap","LbSnatIpPool"],"type":"string"},"port_overload":{"description":"Both SNAT automap and SNAT IP list modes support port overloading\nwhich allows the same SNAT IP and port to be used for multiple\nbackend connections as long as the tuple (source IP, source port,\ndestination IP, destination port, IP protocol) after SNAT is\nperformed is unique.\nThe valid number is 1, 2, 4, 8, 16, 32.\nThis is a deprecated property. The port overload factor is fixed\nto 32 in load balancer engine. If it is upgraded from an old version,\nthe value would be changed to 32 automatically.\n","title":"port overloading with same SNAT IP and port","default":32,"format":"int64","maximum":32,"x-deprecated":true,"minimum":1,"type":"integer"}}},"PostVmGroupMigrationSpec":{"description":"Migration spec for a VM group that will be used in post VM group migration step.","title":"Migration spec for a VM group","required":["group_id"],"x-vmw-nsx-module":"Migration","type":"object","properties":{"allow_override":{"default":false,"readOnly":false,"type":"boolean","description":"Flag to indicate whether to re-run the post migrate steps for the VM group if they are already run before.","title":"Flag for re-running post migrate steps"},"group_id":{"readOnly":false,"type":"string","description":"User defined VM group id that must be unique among all VM groups ids and also should match the group id used in the pre VM group migrate API.","title":"User defined VM group id"},"failed_vm_instance_ids":{"items":{"type":"string"},"readOnly":false,"type":"array","description":"List of instance uuids of VMs that failed to migrate.","title":"List of instance uuids of VMs"}}},"RestoreConfiguration":{"description":"Configuration where backup files are stored for restore","title":"Configuration where backup files are stored for restore","required":["remote_file_server"],"x-vmw-nsx-module":"BackupConfiguration","type":"object","properties":{"remote_file_server":{"$ref":"#/definitions/RemoteFileServer"},"passphrase":{"type":"string","description":"Passphrase used to encrypt backup files.","title":"Passphrase used to encrypt backup files."}}},"EsxGlobalOpaqueConfig":{"x-vmw-nsx-module":"GlobalConfigs","allOf":[{"$ref":"#/definitions/GlobalConfigs"},{"required":["opaque_config"],"x-vmw-nsx-module":"GlobalConfigs","type":"object","properties":{"opaque_config":{"items":{"$ref":"#/definitions/KeyValuePair"},"type":"array","description":"A list of global opaque configuration for ESX hosts.","title":"A list of global opaque configuration for ESX hosts."}}}],"description":"ESX global opaque configuration","title":"ESX global opaque configuration"},"LbVariableAssignmentAction":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/LbRuleAction"},{"required":["variable_value","variable_name"],"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"variable_value":{"type":"string","description":"Value of variable","title":"Value of variable"},"variable_name":{"type":"string","description":"Name of the variable to be assigned","title":"Name of the variable to be assigned"}}}],"description":"This action is used to create a new variable and assign value to it.\nOne action can be used to create one variable. To create multiple\nvariables, multiple actions must be defined.\nThe variables can be used by LbVariableCondition, etc.\n","title":"Action to create variable and assign value to it."},"PortConnectionError":{"x-vmw-nsx-module":"PortConnection","type":"object","description":"Errors encountered while fetching entities in the forwarding path","properties":{"error_summary":{"type":"string"},"error_details":{"type":"object"},"entity_type":{"type":"string"}},"title":"Errors encountered while fetching entities in the forwarding path"},"LogicalSwitchListResult":{"x-vmw-nsx-module":"LogicalSwitch","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"LogicalSwitch","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/LogicalSwitch"},"readOnly":true,"type":"array","description":"Logical Switch Results","title":"Logical Switch Results"}}}],"description":"Logical Switch queries result","title":"Logical Switch queries result"},"NodeSummaryList":{"x-vmw-nsx-module":"Migration","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/NodeSummary"},"type":"array","description":"List of Node Summary","title":"List of Node Summary"}}},"TraceflowObservationForwarded":{"x-vmw-nsx-module":"Traceflow","allOf":[{"$ref":"#/definitions/TraceflowObservation"},{"x-vmw-nsx-module":"Traceflow","type":"object","properties":{"uplink_name":{"type":"string","description":"The name of the uplink the traceflow packet is forwarded on","title":"The name of the uplink the traceflow packet is forwarded on"},"vtep_label":{"format":"int64","type":"integer","description":"The virtual tunnel endpoint label","title":"The virtual tunnel endpoint label"},"remote_ip_address":{"description":"IP address of the destination end of the tunnel","format":"ip","type":"string"},"context":{"format":"int64","type":"integer","description":"The 64bit tunnel context carried on the wire","title":"The 64bit tunnel context carried on the wire"},"local_ip_address":{"description":"IP address of the source end of the tunnel","format":"ip","type":"string"},"dst_transport_node_id":{"readOnly":true,"type":"string","description":"This field will not be always available. Use remote_ip_address when this field is not set.","title":"The id of the transport node to which the traceflow packet is forwarded"},"dst_transport_node_name":{"readOnly":true,"type":"string","description":"The name of the transport node to which the traceflow packet is forwarded","title":"The name of the transport node to which the traceflow packet is forwarded"}}}]},"IdsGlobalConfig":{"x-vmw-nsx-module":"GlobalConfigs","allOf":[{"$ref":"#/definitions/GlobalConfigs"},{"x-vmw-nsx-module":"GlobalConfigs","type":"object","properties":{"global_idsevents_to_syslog_enabled":{"default":false,"type":"boolean","description":"When this flag is set to true, IDS events would be sent to syslog.","title":"A flag to indicate if IDS events need to be sent to syslog"}}}],"description":"NSX global configs for Distributed Intrusion Services","title":"NSX global configs for Distributed Intrusion Services"},"UpgradeCheckFailureMessage":{"x-vmw-nsx-module":"Upgrade","type":"object","description":"Pre/post-upgrade check failure message","properties":{"message":{"readOnly":true,"type":"string","description":"Error/warning message","title":"Error/warning message"},"error_code":{"readOnly":true,"format":"int64","type":"integer","description":"Error code for the error/warning","title":"Error code"}},"title":"Upgrade check failure message"},"NodeSearchDomainsProperties":{"x-vmw-nsx-module":"MISSING_MODULE","allOf":[{"$ref":"#/definitions/Resource"},{"required":["search_domains"],"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"search_domains":{"items":{"type":"string"},"type":"array","description":"Search domains","title":"Search domains"}}}],"description":"Node network search domains properties","title":"Node network search domains properties"},"Alarm":{"x-vmw-nsx-module":"Monitoring","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"Monitoring","required":["status"],"type":"object","properties":{"last_reported_time":{"description":"Indicates when the corresponding Event instance was last reported in\nmilliseconds since epoch.\n","format":"int64","readOnly":true,"type":"integer"},"status":{"description":"Indicate the status which the Alarm is in.\n","enum":["OPEN","ACKNOWLEDGED","SUPPRESSED","RESOLVED"],"type":"string"},"entity_id":{"readOnly":true,"type":"string","description":"The entity that the Event instance applies to. Note entity_id may not\nbe included in a response body. For example, the cpu_high Event may not\nreturn an entity_id.\n","title":"The UUID of the entity that the Event instance applies to"},"event_type":{"readOnly":true,"type":"string","description":"Name of Event, e.g. manager_cpu_usage_high, certificate_expired.\n","title":"Name of event"},"recommended_action":{"readOnly":true,"type":"string","description":"Recommended action for Alarm. This is the same action as the\ncorresponding Event identified by feature_name.event_type.\n","title":"Recommended action for Alarm"},"node_id":{"readOnly":true,"type":"string","description":"The UUID of the node that the Event instance applies to.\n","title":"The UUID of the node that the Event instance applies to"},"feature_name":{"readOnly":true,"type":"string","description":"Feature defining this Event, e.g. manager_health, certificates.\n","title":"Feature defining this event"},"resolved_by":{"readOnly":true,"type":"string","description":"User ID of the user that set the status value to RESOLVED. This value\ncan be SYSTEM to indicate that the system resolved the Alarm, for\nexample when the system determines CPU usage is no longer high and the\ncpu_high Alarm is no longer applicable. This property is only returned\nwhen the status value is RESOLVED.\n","title":"User ID of the user that set the status value to RESOLVED"},"id":{"readOnly":true,"type":"string","description":"ID that uniquely identifies an Alarm.\n","title":"ID that uniquely identifies an Alarm"},"event_type_display_name":{"readOnly":true,"type":"string","description":"Display name of Event type.\n","title":"Display name of event type"},"node_display_name":{"readOnly":true,"type":"string","description":"Display name of node that the event instance applies to.\n","title":"Display name of node"},"summary":{"readOnly":true,"type":"string","description":"Summary description of Alarm. This is the same summary description as the corresponding\nEvent identified by feature_name.event_type.\n","title":"Summary description of Alarm"},"alarm_source_type":{"description":"Type of alarm source of the Event instance. Can be one of - INTENT_PATH, ENTITY_ID.\n","enum":["INTENT_PATH","ENTITY_ID"],"readOnly":true,"type":"string"},"description":{"readOnly":true,"type":"string","description":"Detailed description of Alarm. This is the same detailed description as the corresponding\nEvent identified by feature_name.event_type.\n","title":"Detailed description of Alarm"},"node_resource_type":{"readOnly":true,"type":"string","description":"The resource type of node that the Event instance applies to\neg. ClusterNodeConfig, TransportNode.\n","title":"The resource type of node that the Event instance applies to"},"severity":{"description":"Severity of the Alarm.Can be one of - CRITICAL, HIGH, MEDIUM, LOW.\n","enum":["CRITICAL","HIGH","MEDIUM","LOW"],"readOnly":true,"type":"string"},"alarm_source":{"description":"If alarm_source_type = INTENT_PATH, this field will contain a\nlist of intent paths for the entity that the event instance applies to.\nIf alarm_source_type = ENTITY_ID, this field will contain a list with\na single item identifying the entity id that the event instance applies\nto.\n","title":"Source identifying entity that the Event instance applies to\n","items":{"type":"string"},"readOnly":true,"uniqueItems":true,"type":"array"},"feature_display_name":{"readOnly":true,"type":"string","description":"Display name of feature defining this Event.\n","title":"Display name of feature"},"suppressed_by":{"readOnly":true,"type":"string","description":"User ID of the user that set the status value to SUPPRESSED.\nThis property is only returned when the status value is SUPPRESSED.\n","title":"User ID of the user that set the status value to SUPPRESSED"},"suppress_start_time":{"description":"Indicates when the Alarm was suppressed in milliseconds since epoch.\nThis property is only returned when the status value is SUPPRESSED.\n","format":"int64","readOnly":true,"type":"integer"},"resolved_time":{"description":"Indicates when the Alarm was resolved in milliseconds since epoch.\nThis property is only returned when the status value is RESOLVED.\n","format":"int64","readOnly":true,"type":"integer"},"entity_resource_type":{"readOnly":true,"type":"string","description":"The entity type that the Event instance applies to.\n","title":"The type of entity that the Event instance applies to"},"suppress_duration":{"format":"int64","type":"integer","description":"The time period between suppress_start_time and suppress_start_time +\nsuppress_duration (specified in hours) an Alarm is SUPPRESSED.\nThis property is only returned when the status value is SUPPRESSED.\n","title":"Duration in hours for which an Alarm is SUPPRESSED"},"runtime_data":{"readOnly":true,"type":"string","description":"Runtime data for Alarm. When an alarming condition occurs, there may\nbe additional data of interest when triaging the underlying issue, for\nexample, output from system commands captured at the time of the error.\nNote, the contents of this property are not localized.\n","title":"Runtime data for Alarm"},"node_ip_addresses":{"items":{"type":"string"},"readOnly":true,"type":"array","description":"IP addresses of node that the event instance applies to.\n","title":"IP addresses of node"},"reoccurrences_while_suppressed":{"readOnly":true,"format":"int64","type":"integer","description":"The number of reoccurrences since this alarm has been SUPPRESSED.\n","title":"The number of reoccurrences since this alarm has been SUPPRESSED"}}}]},"HaVipConfig":{"x-vmw-nsx-module":"LogicalRouter","required":["ha_vip_subnets","redundant_uplink_port_ids"],"type":"object","properties":{"ha_vip_subnets":{"description":"Array of IP address subnets which will be used as floating IP addresses. | Note - this configuration is applicable only for Active-Standby LogicalRouter. | For Active-Active LogicalRouter this configuration will be rejected.","title":"Floating IP address subnets","minItems":1,"items":{"$ref":"#/definitions/VIPSubnet"},"maxItems":2,"type":"array"},"redundant_uplink_port_ids":{"description":"Identifiers of logical router uplink ports which are to be paired to provide | redundancy. Floating IP will be owned by one of these uplink ports (depending upon | which node is Active).","title":"Identifiers of uplink ports for providing redundancy","minItems":2,"items":{"type":"string"},"maxItems":2,"type":"array"},"enabled":{"default":true,"type":"boolean","description":"Flag to enable this ha vip config.","title":"Flag to enable this ha vip config."}}},"MetadataProxyStatus":{"x-vmw-nsx-module":"AggSvcMetadataProxy","required":["proxy_status","transport_nodes"],"type":"object","properties":{"proxy_status":{"enum":["UP","DOWN","ERROR","NO_BACKUP"],"type":"string","description":"UP means the metadata proxy is working fine on both transport-nodes(if have);\nDOWN means the metadata proxy is is down on both transport-nodes(if have),\nhence the metadata proxy will not repsonse any metadata request;\nError means error happens on transport-node(s) or no status is reported from\ntransport-node(s). The metadata proxy may be working (or not working);\nNO_BACK means metadata proxy is working in one of the transport node while\nnot in the other transport-node (if have). Hence if the metadata proxy in\nthe working transport-node goes down, the metadata proxy will go down.\n"},"error_message":{"type":"string","description":"Error message, if available","title":"Error message, if available"},"transport_nodes":{"items":{"type":"string"},"type":"array","description":"Order of the transport nodes is insensitive because Metadata Proxy\nis running in Active-Active mode among target transport nodes.\n","title":"ids of transport nodes where this metadata proxy is running"}}},"AuditLog":{"description":"Audit log in RFC5424 format","title":"Audit log in RFC5424 format","required":["procid","full_log","appname","timestamp","hostname","struct_data","priority","facility","msgid","message"],"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"priority":{"format":"int64","type":"integer","description":"Priority field of the log","title":"Priority field of the log"},"procid":{"format":"int64","type":"integer","description":"Process ID field of the log","title":"Process ID field of the log"},"facility":{"format":"int64","type":"integer","description":"Facility field of the log","title":"Facility field of the log"},"full_log":{"type":"string","description":"Full log with both header and message","title":"Full log with both header and message"},"msgid":{"type":"string","description":"Message ID field of the log","title":"Message ID field of the log"},"appname":{"type":"string","description":"Application name field of the log","title":"Application name field of the log"},"timestamp":{"type":"string","description":"Date and time in UTC of the log","title":"Date and time in UTC of the log"},"message":{"type":"string","description":"Message field of the log","title":"Message field of the log"},"hostname":{"type":"string","description":"Hostname field of the log","title":"Hostname field of the log"},"struct_data":{"$ref":"#/definitions/StructuredData"}}},"L2VpnAttachmentContext":{"x-vmw-nsx-module":"LogicalPort","allOf":[{"$ref":"#/definitions/AttachmentContext"},{"x-vmw-nsx-module":"LogicalPort","required":["tunnel_id"],"type":"object","properties":{"local_egress_ip":{"items":{"description":"IPElement can be a single IP address, IP address range or a Subnet. Its\ntype can be of IPv4 or IPv6. Supported list of formats are \"192.168.1.1\",\n\"192.168.1.1-192.168.1.100\", \"192.168.0.0/24\",\n\"fe80::250:56ff:fe83:318c\",\n\"fe80::250:56ff:fe83:3181-fe80::250:56ff:fe83:318c\",\n\"fe80::250:56ff:fe83:318c/64\"\n","format":"address-or-block-or-range","type":"string"},"type":"array","description":"List of local egress IP addresses, used for\nlocal egress optimization.\n","title":"Array of local egress IPs"},"tunnel_id":{"description":"Tunnel Id to uniquely identify the extension.","format":"int32","title":"Tunnel Id to uniquely identify the extension.","maximum":4093,"minimum":1,"type":"integer"}}}]},"NatStatisticsPerTransportNode":{"x-vmw-nsx-module":"AggSvcLogicalRouter","allOf":[{"$ref":"#/definitions/NatCounters"},{"x-vmw-nsx-module":"AggSvcLogicalRouter","type":"object","properties":{"last_update_timestamp":{"description":"Timestamp when the data was last updated; unset if data source has never updated the data.","format":"int64","readOnly":true,"type":"integer"},"transport_node_id":{"readOnly":true,"type":"string","description":"Id for the transport node","title":"Id for the transport node"}}}]},"MPPolicyPromotionHistoryList":{"x-vmw-nsx-module":"PolicyMigration","type":"object","description":"List of MPPolicyPromotionHistory.\n","properties":{"results":{"items":{"$ref":"#/definitions/MPPolicyPromotionHistory"},"type":"array","description":"Array of MPPolicyPromotionHistory.\n","title":"Array of MPPolicyPromotionHistory."}},"title":"List of MPPolicyPromotionHistory.\n"},"StandardHostSwitch":{"x-vmw-nsx-module":"TransportNode","type":"object","description":"Standard host switch specification","properties":{"host_switch_type":{"default":"NVDS","enum":["NVDS","VDS"],"type":"string","description":"VDS represents VMware vSphere Distributed Switch from vSphere that is used as HostSwitch through TransportNode or TransportNodeProfile configuration. When VDS is used as a HostSwitch, Hosts have to be added to VDS from vSphere and VDS instance is created on Hosts. To configure NSX on such hosts, you can use this VDS as a HostSwitch from NSX manager. vCenter has the ownership of MTU, LAG, NIOC and LLDP configuration of such VDS backed HostSwitch. Remaining configuration (e.g. UplinkHostswitchProfile) will be managed by NSX.\nNVDS represents NSX Virtual Switch which is NSX native HostSwitch. All configurations of NVDS will be managed by NSX. HostSwitch of type NVDS has been deprecated on ESX hosts that are managed by a vCenter Server.","title":"Type of HostSwitch"},"pnics_uninstall_migration":{"items":{"$ref":"#/definitions/Pnic"},"type":"array","description":"This is only supported for NVDS type of host switch. If this is specified for VDS type of host switch, an error will be returned to user. The pnics to be migrated out to a non N-VDS switch during transport node deletion.","title":"Physical NICs connected to a switch"},"uplinks":{"items":{"$ref":"#/definitions/VdsUplink"},"type":"array","description":"If VDS is used as a HostSwitch this attribute must be specified. You can associate uplinks from UplinkHostSwitchProfile to either VDS uplink or LAG. VDS uplink or LAG will inherit the global VDS level teaming policy from vSphere. NSX managed uplink or LAG will have NSX teaming policy configured through UplinkHostSwitchProfile.","title":"Uplink/LAG of VMware vSphere Distributed Switch connected to the HostSwitch"},"host_switch_name":{"default":"nsxDefaultHostSwitch","type":"string","description":"This field is writable only in case of NVDS type HostSwitch and system generated for VDS type. For NVDS type host switch, If this name is unset or empty then the default host switch name will be used. The name must be unique among all host switches specified in a given transport node; unset name, empty name and the default host switch name are considered the same in terms of uniqueness. For VDS type host switch, Manager fetches VDS name from corresponding Compute Manager and populates this field. If VDS name is given (correct or incorrect) it is ignored and overwritten with correct one.","x-deprecated":true,"title":"host switch name. This name will be used to reference a host switch."},"host_switch_id":{"type":"string","description":"This field is writable only in case of VDS type HostSwitch and system generated for NVDS type. For VDS type host switch, This field is used to lookup a VDS from corresponding Compute Manager and then can be configured for logical networking. For NVDS type host switch, This field is system generated and if provided will be overwritten.","title":"The host switch id. This ID will be used to reference a host switch."},"transport_zone_endpoints":{"items":{"$ref":"#/definitions/TransportZoneEndPoint"},"readOnly":false,"type":"array","description":"List of TransportZones that are to be associated with specified host switch.\nIf this property is specified, host_switch_mode at StandardHostSwitch level must be specified.","title":"Transport zone endpoints."},"portgroup_transport_zone_id":{"readOnly":true,"type":"string","description":"A transport zone will be created for each DVS found across all hosts in a cluster that is installed for NSX on DVPG. This field, populated by NSX, is the ID of the transport zone created for the DVS this host switch represents. All discovered segments created for the DVPGs found on the DVS will have this ID specified as the transport zone id.","title":"Transport Zone ID representing the DVS used in NSX on DVPG"},"vmk_install_migration":{"items":{"$ref":"#/definitions/VmknicNetwork"},"type":"array","description":"This is only supported for NVDS type of host switch. If this is specified for VDS type of host switch, an error will be returned to user. The vmk interfaces and the associated logical switches on the host switch. The state of this field is realized on the transport node during creation and update.","title":"The vmknic and logical switch mappings"},"ip_assignment_spec":{"$ref":"#/definitions/IpAssignmentSpec"},"cpu_config":{"items":{"$ref":"#/definitions/CpuCoreConfigForEnhancedNetworkingStackSwitch"},"readOnly":false,"type":"array","description":"CPU configuration specifies number of Logical cpu cores (Lcores) per Non Uniform Memory Access (NUMA) node dedicated to Enhanced Networking Stack enabled HostSwitch to get the best performance.","title":"Enhanced Networking Stack enabled HostSwitch CPU configuration"},"is_migrate_pnics":{"default":false,"type":"boolean","description":"If the pnics specified in the pnics field are used by a single Vsphere Standard Switch or DVS, then migrate the pnics to N-VDS. If any two pnics are not used by the same Vsphere Standard Switch or DVS, it is not supported. In such cases, please migrate them in multiple steps, one Vsphere Standard Switch or DVS at a time.","title":"Migrate any pnics which are in use"},"vmk_uninstall_migration":{"items":{"$ref":"#/definitions/VmknicNetwork"},"type":"array","description":"This is only supported for NVDS type of host switch. If this is specified for VDS type of host switch, an error will be returned to user. The vmk interfaces and the associated portgroups on the VSS/DVS. This field is realized on the host during transport node deletion or NSX uninstallation to specify the destination for all vmks on N-VDS switches.","title":"The vmknic and portgroup mappings"},"pnics":{"items":{"$ref":"#/definitions/Pnic"},"type":"array","description":"Pnics are specified when HostSwitch is of type NVDS. When using the Quick Start workflow on 7.0 clusters, pnic information will be populated by the recommendation when providing a VDS HostSwitch based on a VSS HostSwitch.","title":"Physical NICs connected to the host switch"},"host_switch_mode":{"readOnly":false,"enum":["STANDARD","ENS","ENS_INTERRUPT"],"type":"string","description":"STANDARD - This mode applies to all the hypervisors. ENS - This is the Enhanced Data Path switch mode. This mode provides accelerated networking performances but also introduces additional prerequisites. In order to benefit from this mode, workloads will be need to be compiled with DPDK and will use VMXNET3 for their vNIC. This mode is only available on ESX hypervisor (6.7 and above, recommended 6.7 U2 and above) and unavailable on KVM, EDGE and Public Cloud Gateway. Not all NSX features are available in this mode, please consult the documentation. ENS_INTERRUPT - This is an interrupt driven variant of the Enhanced Data Path mode. Please, consult your account representative for applicability. This mode is available only on ESX hypervisor (7.0 and above).\nIf this property is specified, transport_zone_endpoints must be specified at StandardHostSwitch level.","title":"Operational mode of a HostSwitch."},"host_switch_profile_ids":{"items":{"$ref":"#/definitions/HostSwitchProfileTypeIdEntry"},"type":"array","description":"Host switch profiles bound to this host switch. If a profile ID is not provided for any HostSwitchProfileType that is supported by the transport node, the corresponding default profile will be bound to the host switch. If transport node is created using Policy APIs, use policyPaths instead of UUIDs.","title":"Identifiers of host switch profiles to be associated with this host switch."}},"title":"Standard host switch specification"},"IncludedFieldsParameters":{"x-vmw-nsx-module":"Common","type":"object","description":"A list of fields to include in query results","properties":{"included_fields":{"type":"string","description":"Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.","title":"Comma separated list of fields that should be included in query result"}},"title":"A list of fields to include in query results"},"GroupedMigrationFeedbackRequest":{"description":"Detailed feedback requests from the migration tool where user input is required.","title":"Grouped Feedback detail required for Migration","required":["objects"],"x-vmw-nsx-module":"Migration","type":"object","properties":{"resolved":{"readOnly":true,"type":"boolean","description":"Indicates if a valid response already exist for all feedback requests in this group.","title":"Indicates if all feedback requests in this group are resolved"},"accepted_actions":{"items":{"type":"string"},"readOnly":true,"type":"array","description":"List of acceptable actions for this feedback request.","title":"Acceptable actions for this feedback request"},"hash":{"readOnly":true,"type":"string","description":"Identify a feedback request type across objects. This can be used to group together objects with similar feedback request and resolve them in one go.","title":"Identifier for a feedback request type"},"vertical":{"readOnly":true,"type":"string","description":"Functional area that this query falls into.","title":"Functional area for the feedback query"},"suggested_value":{"readOnly":true,"type":"string","description":"The suggested value to resolve this feedback request.","title":"Suggested value for this feedback request"},"multi_value":{"readOnly":true,"type":"boolean","description":"Indicates if multiple values can be selected as response from the list of acceptable value.","title":"Indicates if multiple values can be selected as response"},"sub_vertical":{"readOnly":true,"type":"string","description":"Functional sub-area that this query falls into.","title":"Functional sub-area for the feedback query"},"objects":{"items":{"$ref":"#/definitions/SummaryMigrationFeedbackRequest"},"readOnly":false,"type":"array","description":"Collection of feedback requests of a given type","title":"Collection of feedback requests of a given type"},"accepted_values":{"items":{"type":"string"},"type":"array","description":"List of acceptable values for this feedback request.","title":"Acceptable values for this feedback request"},"message":{"readOnly":true,"type":"string","description":"Detailed feedback request with options.","title":"Content of feedback request"},"accepted_value_type":{"readOnly":true,"type":"string","description":"Data type of the items listed in acceptable values list.","title":"Data type of the items listed in acceptable values"},"suggested_action":{"readOnly":true,"type":"string","description":"The suggested action to resolve this feedback request.","title":"Suggested action for this feedback request"}}},"FirstNSampling":{"x-vmw-nsx-module":"LiveTrace","allOf":[{"$ref":"#/definitions/SamplingArgument"},{"x-vmw-nsx-module":"LiveTrace","required":["match_number"],"type":"object","properties":{"match_number":{"description":"Number of packets to be sampled","format":"int64","title":"Number of packets to be sampled","maximum":500,"minimum":1,"type":"integer"}}}]},"ErrorResolverSystemMetadata":{"x-vmw-nsx-module":"ErrorResolver","type":"object","description":"Metadata fetched from an external system like Syslog or LogInsight.","properties":{"value":{"type":"string","description":"The value fetched from another system","title":"The value fetched from another system"}}},"VersionList":{"x-vmw-nsx-module":"VersionWhitelist","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"VersionWhitelist","required":["acceptable_versions"],"type":"object","properties":{"acceptable_versions":{"items":{"type":"string"},"type":"array","description":"List of component versions","title":"List of component versions"}}}]},"ApplianceLatencyData":{"x-vmw-nsx-module":"ShaApplianceMonitor","allOf":[{"$ref":"#/definitions/Resource"},{"x-vmw-nsx-module":"ShaApplianceMonitor","type":"object","properties":{"latency_data":{"items":{"$ref":"#/definitions/ApplianceLatencyDataItem"},"type":"array","description":"Latency Data list.","title":"Latency Data List"},"id":{"type":"string","description":"Display the Appliance id.","title":"Appliance id"},"timestamp":{"type":"integer","description":"Timestamp of last modification.","format":"int64"},"name":{"type":"string","description":"Display the appliance name.","title":"Appliance name"}}}],"description":"Display the latency data by given appliance node","title":"Display the latency data by given appliance node"},"NeighborProperties":{"x-vmw-nsx-module":"Lldp","type":"object","description":"Neighbor properties","properties":{"system_name":{"readOnly":true,"type":"string","description":"System name","title":"System name"},"system_desc":{"readOnly":true,"type":"string","description":"System description","title":"System description"},"system_port_number":{"readOnly":true,"format":"int64","type":"integer","description":"System port number","title":"System port number"},"name":{"readOnly":true,"type":"string","description":"Interface name","title":"Interface name"},"oid":{"readOnly":true,"type":"string","description":"Object identifier","title":"Object identifier"},"mgmt_addr":{"readOnly":true,"type":"string","description":"Management address","title":"Management address"},"capabilities":{"readOnly":true,"type":"string","description":"Capabilities","title":"Capabilities"},"link_aggregation_status":{"readOnly":true,"type":"boolean","description":"True if currently in aggregation","title":"Aggregation Status"},"ifindex":{"readOnly":true,"format":"int64","type":"integer","description":"Interface index","title":"Interface index"},"mac":{"readOnly":true,"type":"string","description":"Interface MAC address","title":"Interface MAC address"},"link_aggregation_capable":{"readOnly":true,"type":"boolean","description":"Aggregation Capability","title":"Aggregation Capability"},"port_desc":{"readOnly":true,"type":"string","description":"Port description","title":"Port description"},"enabled_capabilities":{"readOnly":true,"type":"string","description":"Enabled capabilities","title":"Enabled capabilities"},"link_aggregation_port_id":{"readOnly":true,"type":"string","description":"Aggregation port id","title":"Aggregation port id"}},"title":"Neighbor properties"},"LbFastTcpProfile":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/LbAppProfile"},{"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"close_timeout":{"description":"It is used to specify how long a closing TCP connection (both FINs\nreceived or a RST is received) should be kept for this application\nbefore cleaning up the connection.\n","title":"TCP connection idle timeout in seconds","default":8,"format":"int64","maximum":60,"minimum":1,"type":"integer"},"idle_timeout":{"description":"It is used to configure how long an idle TCP connection in ESTABLISHED\nstate should be kept for this application before cleaning up.\n","title":"TCP connection idle timeout in seconds","default":1800,"format":"int64","maximum":2147483647,"minimum":1,"type":"integer"},"ha_flow_mirroring_enabled":{"default":false,"type":"boolean","description":"If flow mirroring is enabled, all the flows to the bounded virtual\nserver are mirrored to the standby node.\n","title":"flow mirroring enabled flag"}}}]},"Snmpv3User":{"description":"This object contains properties for a SNMP v3 user that can be used to receive SNMP traps/notifications from NSX and/or poll NSX nodes over SNMP.","title":"SNMP v3 user","required":["user_id"],"x-vmw-nsx-module":"CentralConfig","type":"object","properties":{"priv_password":{"type":"string","description":"Privacy password used for SNMP v3 communication. This field is required when adding a user. When updating a user, do not include this field in the request. If this field is present in an update request, it will be considered as a new value for privacy password.","title":"Privacy password"},"access":{"default":"READ_ONLY","enum":["READ_ONLY"],"type":"string","description":"Access permissions for polling NSX nodes over SNMP v3.","title":"Type of access"},"auth_password":{"type":"string","description":"Authentication password used for SNMP v3 communication. This field is required when adding a user. When updating a user, do not include this field in the request. If this field is present in an update request, it will be considered as a new value for authentication password.","title":"Authentication password"},"user_id":{"minLength":1,"maxLength":32,"type":"string","description":"Unique SNMP v3 user id.","title":"User ID"},"security_level":{"default":"AUTH_PRIV","enum":["AUTH_PRIV"],"type":"string","description":"Security level indicates whether SNMP communication involves authentication and privacy protocols for this user. Value \"AUTH_PRIV\" indicates both authentication and privacy protocols will be used for SNMP communication.","title":"Security level"}}},"LogicalPortMacTableEntry":{"x-vmw-nsx-module":"AggSvcLogicalPort","required":["mac_type","mac_address"],"type":"object","properties":{"mac_type":{"description":"The type of the MAC address","enum":["STATIC","LEARNED"],"type":"string"},"mac_address":{"type":"string","description":"The MAC address","title":"The MAC address"}}},"NodeServiceStatusProperties":{"x-vmw-nsx-module":"MISSING_MODULE","allOf":[{"$ref":"#/definitions/Resource"},{"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"reason":{"readOnly":true,"type":"string","description":"Reason for service degradation","title":"Reason for service degradation"},"health":{"readOnly":true,"enum":["STABLE","DEGRADED"],"type":"string","description":"Service health in addition to runtime_state","title":"Service health in addition to runtime_state"},"monitor_pid":{"readOnly":true,"format":"int64","type":"integer","description":"Service monitor process id","title":"Service monitor process id"},"pids":{"items":{"type":"integer","format":"int64"},"readOnly":true,"type":"array","description":"Service process ids","title":"Service process ids"},"runtime_state":{"readOnly":true,"enum":["running","stopped"],"type":"string","description":"Service runtime state","title":"Service runtime state"},"monitor_runtime_state":{"readOnly":true,"enum":["running","stopped"],"type":"string","description":"Service monitor runtime state","title":"Service monitor runtime state"}}}],"description":"Node service status properties","title":"Node service status properties"},"UpgradeUnitGroupAggregateInfoListResult":{"x-vmw-nsx-module":"Upgrade","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"Upgrade","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/UpgradeUnitGroupAggregateInfo"},"readOnly":true,"type":"array","description":"Paged collection of upgrade status for upgrade unit groups","title":"Paged collection of upgrade status for upgrade unit groups"}}}]},"DeploymentConfig":{"discriminator":"placement_type","x-vmw-nsx-module":"FabricNode","required":["placement_type"],"type":"object","properties":{"placement_type":{"enum":["VsphereDeploymentConfig"],"type":"string"}}},"IdfwMasterSwitchSetting":{"description":"Identity Firewall master switch setting. This setting enables or disables\nIdentity Firewall feature across the system. It affects compute collections,\nhypervisor and virtual machines. This operation is expensive and also has big\nimpact and implication on system perforamce.\n","title":"Identity Firewall master switch setting","required":["idfw_master_switch_enabled"],"x-vmw-nsx-module":"IdentityFirewall","type":"object","properties":{"idfw_master_switch_enabled":{"type":"boolean","description":"IDFW master switch (true=Enabled / false=Disabled).","title":"IDFW master switch"}}},"ClientSslProfileBinding":{"x-vmw-nsx-module":"LoadBalancer","required":["default_certificate_id"],"type":"object","properties":{"client_auth":{"description":"client authentication mode","default":"IGNORE","enum":["REQUIRED","IGNORE"],"type":"string"},"ssl_profile_id":{"type":"string","description":"Client SSL profile defines reusable, application-independent client side\nSSL properties.\n","title":"client SSL profile identifier"},"certificate_chain_depth":{"description":"authentication depth is used to set the verification depth in the client\ncertificates chain.\n","title":"the maximum traversal depth of client certificate chain","default":3,"format":"int64","maximum":2147483647,"minimum":1,"type":"integer"},"client_auth_ca_ids":{"items":{"type":"string"},"type":"array","description":"If client auth type is REQUIRED, client certificate must be signed by\none of the trusted Certificate Authorities (CAs), also referred to as\nroot CAs, whose self signed certificates are specified.\n","title":"CA identifier list to verify client certificate"},"default_certificate_id":{"type":"string","description":"A default certificate should be specified which will be used if the\nserver does not host multiple hostnames on the same IP address or if\nthe client does not support SNI extension.\n","title":"default service certificate identifier"},"sni_certificate_ids":{"items":{"type":"string"},"type":"array","description":"Client-side SSL profile binding allows multiple certificates, for\ndifferent hostnames, to be bound to the same virtual server.\n","title":"SNI certificate identifier list"},"client_auth_crl_ids":{"items":{"type":"string"},"type":"array","description":"A Certificate Revocation List (CRL) can be specified in the client-side\nSSL profile binding to disallow compromised client certificates.\n","title":"CRL identifier list to verify client certificate"}}},"VdsTopology":{"x-vmw-nsx-module":"NvdsUpgradeReadinessCheck","allOf":[{"$ref":"#/definitions/ManagedResource"},{"required":["data_center_id","vds_name","transport_node_id"],"x-vmw-nsx-module":"NvdsUpgradeReadinessCheck","type":"object","properties":{"vds_status":{"readOnly":true,"enum":["PENDING_TOPOLOGY","APPLYING_TOPOLOGY","APPLY_TOPOLOGY_FAILED","READY","REMOVING_TOPOLOGY"],"type":"string","description":"Status of the VDS configuration","title":"Status of the VDS configuration"},"vmknic":{"items":{"type":"string"},"type":"array","description":"Virtual network interfaces that will be moved from VLAN Logical switch to Distributed Virtual PortGroup","title":"Virtual network interfaces that will be moved from VLAN Logical switch to Distributed Virtual PortGroup"},"cluster_id":{"type":"string","description":"Identifier of cluster where VDS will be created","title":"Identifier of cluster where VDS will be created"},"transport_node_id":{"items":{"type":"string"},"type":"array","description":"Transport node identifiers on which NVDS(s) being upgraded to VDS","title":"Transport node identifiers on which NVDS(s) being upgraded to VDS"},"status_details":{"items":{"type":"string"},"readOnly":true,"type":"array","description":"Details of the VDS configuration status","title":"Details of the VDS configuration status"},"vds_config":{"$ref":"#/definitions/DVSConfig"},"vds_name":{"type":"string","description":"VDS name that will be created under above datacenter","title":"VDS name that will be created under above datacenter"},"data_center_id":{"type":"string","description":"Identifier of datacenter where VDS will be created","title":"Identifier of datacenter where VDS will be created"}}}],"description":"VDS details where NVDS will be migrated to","title":"VDS details where NVDS will be migrated to"},"IPSecVPNIKESessionStatus":{"x-vmw-nsx-module":"VPNStatistics","type":"object","description":"Status for IPSec VPN IKE session UP, DOWN, NEGOTIATING and fail reason if IKE session is down.","properties":{"transport_node_id":{"readOnly":true,"type":"string","description":"Transport Node identifier where session is present.","title":"Transport Node Id"},"fail_reason":{"readOnly":true,"type":"string","description":"Reason for failure.","title":"Fail reason"},"ike_session_state":{"readOnly":true,"enum":["UP","DOWN","NEGOTIATING"],"type":"string","description":"IKE session service status UP, DOWN and NEGOTIATING.","title":"IKE session state"}},"title":"IKE session status"},"PrecheckParameters":{"x-vmw-nsx-module":"NvdsUpgradeReadinessCheck","type":"object","description":"Parameters for nvds upgrade precheck","properties":{"cluster_ids":{"items":{"type":"string"},"readOnly":true,"type":"array","description":"Cluster ID list for nvds upgrade precheck","title":"Cluster ID list for nvds upgrade precheck"}},"title":"Parameters for nvds upgrade precheck"},"VirtualMachineTagUpdate":{"x-vmw-nsx-module":"Inventory","required":["external_id","tags"],"type":"object","properties":{"external_id":{"type":"string","description":"External id of the virtual machine to which tags are to be applied","title":"External id of the virtual machine to which tags are to be applied"},"tags":{"items":{"$ref":"#/definitions/Tag"},"type":"array","description":"List of tags to be applied to the virtual machine","title":"List of tags to be applied to the virtual machine"}}},"IdfwVmDetail":{"description":"Identity Firewall user login/session data for a single VM","title":"Identity Firewall user login/session data for a single VM","required":["vm_ext_id","user_sessions"],"x-vmw-nsx-module":"IdentityFirewall","type":"object","properties":{"vm_ext_id":{"type":"string","description":"Virtual machine (external ID or BIOS UUID) where login/logout event occurred.","title":"Virtual machine external ID or BIOS UUID"},"vm_ip_addresses":{"items":{"type":"string"},"type":"array","description":"List of client machine IP addresses.","title":"Client VM IP addresses"},"last_login_user_session":{"$ref":"#/definitions/ResourceReference"},"user_sessions":{"items":{"$ref":"#/definitions/IdfwUserSessionData"},"type":"array","description":"List of user session data.","title":"List of user session data"}}},"PacketCaptureSession":{"x-vmw-nsx-module":"PacketCapture","allOf":[{"$ref":"#/definitions/ManagedResource"},{"required":["sessionid","request","sessionstatus"],"x-vmw-nsx-module":"PacketCapture","type":"object","properties":{"sessionid":{"type":"string","description":"Packet capture session id.","title":"Packet capture session id"},"filelocation":{"type":"string","description":"Packet capture file location.","title":"Packet capture file location"},"filesize":{"format":"int32","type":"integer","description":"Packet capture file Size in bytes.","title":"Packet capture file Size in bytes"},"sessionname":{"type":"string","description":"Packet capture session name.","title":"Packet capture session name"},"errormsg":{"type":"string","description":"Error messasge in capture.","title":"Error messasge in capture"},"endtime":{"type":"integer","description":"Timestamp when session was stopped in epoch millisecond.","format":"int64"},"request":{"$ref":"#/definitions/PacketCaptureRequest"},"starttime":{"type":"integer","description":"Timestamp when session was created in epoch millisecond.","format":"int64"},"sessionstatus":{"enum":["CREATED","STARTED","STOPPED","FINISHED","ERROR"],"type":"string","description":"Packet capture session status.","title":"Packet capture session status"}}}],"description":"Packet capture session information.","title":"Packet capture response information"},"MigratedObject":{"x-vmw-nsx-module":"PolicyMigration","type":"object","description":"Migrated resource.\n","properties":{"policy_path":{"type":"string","description":"Policy path.\n","title":"Policy path."},"parent_resource_type":{"type":"string","description":"Parent resource type.\n","title":"Parent resource type."},"resource_id":{"type":"string","description":"Resource id.\n","title":"Resource id."},"parent_resource_id":{"type":"string","description":"Parent resource id.\n","title":"Parent resource id."},"resource_type":{"type":"string","description":"Resource type.\n","title":"Resource type."},"policy_id":{"type":"string","description":"Policy id.\n","title":"Policy id."}},"title":"Migrated resource.\n"},"LbPoolStatusListResult":{"x-vmw-nsx-module":"AggSvcLb","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"AggSvcLb","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/LbPoolStatus"},"type":"array","description":"paginated status list of pools","title":"paginated status list of pools"}}}]},"EdgeNodeSettings":{"x-vmw-nsx-module":"FabricNode","required":["hostname"],"type":"object","description":"The settings are used during deployment and consequent update of an edge,\nunless indicated otherwise.\nThese settings are editable for manually deployed edge nodes as well.\nIf using DHCP, you must leave the following fields unset: search_domains,\nmanagement_port_subnets, dns_servers and default_gateway_addresses.\nEdgeNodeSettings reports current values configured on the edge node.\nIf the settings lag with actual state on the edge,\nthese may be refreshed at NSX Manager using API POST api/v1/transport-nodes\n/<transport-node-id>?action=refresh_node_configuration&resource_type=\nEdgeNode\n","properties":{"ntp_servers":{"items":{"description":"Hostname or IPv4 address","format":"hostname-or-ipv4","type":"string"},"type":"array","description":"List of NTP servers.\n","title":"NTP servers."},"dns_servers":{"items":{"description":"IPv4 or IPv6 address","format":"ip","type":"string"},"type":"array","description":"List of DNS servers.\n","title":"DNS servers."},"syslog_servers":{"items":{"$ref":"#/definitions/SyslogConfiguration"},"type":"array","description":"List of Syslog server configuration.\n","maxItems":5,"title":"Syslog servers"},"advanced_configuration":{"items":{"$ref":"#/definitions/KeyValuePair"},"readOnly":false,"type":"array","description":"Array of additional specific properties for advanced or cloud-\nspecific deployments in key-value format.\n","title":"Advanced configuration"},"search_domains":{"items":{"type":"string"},"type":"array","description":"List of domain names that are used to complete unqualified host names.\n","title":"Search domain names."},"hostname":{"type":"string","description":"Host name or FQDN for edge node.","title":"Host name or FQDN for edge node."},"enable_ssh":{"default":false,"type":"boolean","description":"Enabling SSH service is not recommended for security reasons.\n","title":"Enable SSH."},"allow_ssh_root_login":{"default":false,"type":"boolean","description":"Allowing root SSH logins is not recommended for security reasons.\nEdit of this property is not supported when updating transport node.\nUse the CLI to change this property.\n","title":"Allow root SSH logins."}}},"MetadataProxyStatistics":{"x-vmw-nsx-module":"AggSvcMetadataProxy","required":["timestamp","metadata_proxy_id"],"type":"object","properties":{"timestamp":{"type":"integer","description":"timestamp of the statistics","format":"int64"},"statistics":{"items":{"$ref":"#/definitions/MetadataProxyStatisticsPerLogicalSwitch"},"type":"array","description":"metadata proxy statistics per logical switch","title":"metadata proxy statistics per logical switch"},"metadata_proxy_id":{"type":"string","description":"metadata proxy uuid","title":"metadata proxy uuid"}}},"IPv6DADStatus":{"x-vmw-nsx-module":"LogicalRouterPorts","type":"object","description":"IPv6 DAD status","properties":{"status":{"description":"DAD status for IP address on the port.\n","enum":["DUPLICATED","TENTATIVE","ASSIGNED","NOT_APPLICABLE","UNKNOWN"],"readOnly":true,"type":"string"},"transport_node":{"items":{"$ref":"#/definitions/ResourceReference"},"readOnly":true,"type":"array","description":"Array of transport node id on which DAD status is reported for\ngiven IP address.\n","title":"Transport node"},"ip_address":{"description":"IP address on the port for which DAD status is reported.\n","format":"ip","readOnly":true,"type":"string"}},"title":"IPv6 DAD status"},"IdfwVirtualMachineStatusListResult":{"x-vmw-nsx-module":"IdentityFirewall","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"IdentityFirewall","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/IdfwVirtualMachineStatus"},"type":"array","description":"List of VM's on Identity Firewall Compute collection.","title":"IDFW Virtual machine list."}}}],"description":"VM ID and status of the Identity Firewall Compute collection.\n","title":"IDFW VM ID and status."},"BgpConfig":{"x-vmw-nsx-module":"Routing","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"Routing","type":"object","properties":{"inter_sr_ibgp":{"$ref":"#/definitions/InterSRRoutingConfig"},"as_number":{"description":"This is a deprecated property, Please use 'as_num' instead. For VRF logical router, the as_number from parent logical router will be effective.","title":"Autonomous System Number","format":"int64","maximum":4294967296,"x-deprecated":true,"minimum":1,"type":"integer"},"route_aggregation":{"description":"List of routes to be aggregated","title":"List of routes to be aggregated","minItems":0,"items":{"$ref":"#/definitions/BgpRouteAggregation"},"maxItems":1000,"type":"array"},"logical_router_id":{"readOnly":true,"type":"string","description":"Logical router id","title":"Logical router id"},"graceful_restart":{"type":"boolean","description":"Flag to enable graceful restart. This field is deprecated, kindly use\ngraceful_restart_config parameter for graceful restart configuration.\nIf both parameters are set and consistent with each other\n[i.e. graceful_restart=false and graceful_restart_mode=HELPER_ONLY OR\ngraceful_restart=true and graceful_restart_mode=GR_AND_HELPER]\nthen this is allowed, but if inconsistent with each other then this\nis not allowed and validation error will be thrown. For VRF logical router,\nthe settings from parent logical router will be effective.\n","x-deprecated":true,"title":"Flag to enable graceful restart"},"as_num":{"type":"string","description":"For VRF logical router, the as_num from parent logical router will be effective.","title":"4 Byte ASN in ASPLAIN/ASDOT Format"},"enabled":{"default":false,"type":"boolean","description":"While creation of BGP config this flag will be set to\n- true for Tier0 logical router with Active-Active high-availability\nmode\n- false for Tier0 logical router with Active-Standby high-availanility\nmode.\nUser can change this value while updating the config. If this\nproperty is not specified in the payload, the default value will be\nconsidered as false irrespective of the high-availability mode.\n","title":"Flag to enable this configuration"},"graceful_restart_config":{"$ref":"#/definitions/GracefulRestartConfig"},"multipath_relax":{"type":"boolean","description":"For TIER0 logical router, default is true. For VRF logical router, the settings from parent logical router will be effective.","title":"Flag to enable BGP multipath relax option."},"ecmp":{"default":true,"type":"boolean","description":"While creation of BGP config this flag will be set to true\nUser can change this value while updating BGP config. If this property\nis not specified in the payload, the default value will be considered\nas true.\n","title":"Flag to enable outbound ECMP"}}}],"description":"BGP configuration for Tier0 logical router. We create BGP configuration\nwhile creation of Tier0 logical router.\n","title":"BGP configuration for logical router"},"MigrationUnitStatusListResult":{"x-vmw-nsx-module":"Migration","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"Migration","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/MigrationUnitStatus"},"type":"array","description":"Paged Collection of migration units status","title":"Paged Collection of migration units status"}}}]},"DhcpStaticBinding":{"x-vmw-nsx-module":"Dhcp","allOf":[{"$ref":"#/definitions/IpAllocationBase"},{"required":["ip_address","mac_address"],"x-vmw-nsx-module":"Dhcp","type":"object","properties":{"ip_address":{"description":"The ip address to be assigned to the host.","format":"ip","type":"string"},"host_name":{"format":"hostname","type":"string","description":"The host name to be assigned to the host.","title":"Host name"},"mac_address":{"description":"The MAC address of the host.","format":"mac-address","type":"string"}}}],"description":"DHCP static binding to define a static ip allocation.","title":"DHCP static binding"},"LogicalPortMacTableCsvEntry":{"x-vmw-nsx-module":"AggSvcLogicalPort","allOf":[{"$ref":"#/definitions/CsvRecord"},{"x-vmw-nsx-module":"AggSvcLogicalPort","required":["mac_type","mac_address"],"type":"object","properties":{"mac_type":{"description":"The type of the MAC address","enum":["STATIC","LEARNED"],"type":"string"},"mac_address":{"type":"string","description":"The MAC address","title":"The MAC address"}}}]},"PortAttacher":{"description":"VM or vmknic entity attached to LogicalPort","title":"VM or vmknic entity attached to LogicalPort","required":["host","entity"],"x-vmw-nsx-module":"LogicalPort","type":"object","properties":{"host":{"readOnly":false,"type":"string","description":"TransportNode on which the attacher resides","title":"TransportNode on which the attacher resides"},"entity":{"readOnly":false,"type":"string","description":"This is a vmknic name if the attacher is vmknic. Otherwise, it is\nfull path of the attached VM's config file\n","title":"Reference to the attached entity"}}},"PacketCaptureRequest":{"description":"This type is used to create packet request on give node. Need to specify related parameters according to the capture point.","title":"Packet capture request information","required":["cappoint","capsource"],"x-vmw-nsx-module":"PacketCapture","type":"object","properties":{"node":{"type":"string","description":"Define the transport node to capture data.","title":"Packet capture node id"},"direction":{"enum":["INPUT","OUTPUT","DUAL"],"type":"string","description":"Define the capture direction. Support three types INPUT/OUTPUT/DUAL.","title":"Packet capture direction type"},"capduration":{"format":"int32","type":"integer","description":"Define the packet capture duration time. After the capture duration time, the capture process will stop working.","title":"Packet capture duration time in seconds"},"capamount":{"format":"int32","type":"integer","description":"Define the packet capture amount size.","title":"Packet capture amount"},"capsource":{"enum":["CLI","UI"],"type":"string","description":"This type is used to differenite the incoming request from CLI/UI.","title":"Packet capture source type"},"node_ip":{"description":"Define the transport node to capture data.","format":"ip","type":"string"},"capvalue":{"type":"string","description":"Define the capture value of given capture point.","title":"Packet capture point value"},"filtertype":{"enum":["PRE","POST"],"type":"string","description":"Define the capture filter type. Support PRE/POST mode.","title":"Packet capture dvfilter stage type"},"cappoint":{"enum":["VNIC","VMKNIC","VMNIC","VDRPORT","DVFILTER","LOGICALPORT","FCPORT","VIF","PNIC"],"type":"string","description":"Define the point to capture data.","title":"Packet capture point"},"capfilesize":{"format":"int32","type":"integer","description":"Define the packet capture file size limit.","title":"Packet capture file size limit"},"options":{"$ref":"#/definitions/PacketCaptureOptionList"},"streamport":{"format":"int32","type":"integer","description":"Set the stream port to receive the capture packet. The STREAM mode is based on GRE-in-UDP Encapsulation(RFC8086). Packets are sent to UDP port 4754.","title":"Packet capture Streaming port"},"caprate":{"format":"int32","type":"integer","description":"Define the rate of packet capture process.","title":"Packet capture rate"},"capcore":{"format":"int32","type":"integer","description":"The CPU core id on Edge node.","title":"The CPU core id on Edge node"},"capsnaplen":{"format":"int32","type":"integer","description":"Limit the number of bytes captured from each packet.","title":"Packet capture snapshot length"},"streamaddress":{"type":"string","description":"Set the stream address to receive the capture packet.","title":"Packet capture Streaming address"},"capmode":{"enum":["STANDALONE","STREAM"],"type":"string","description":"Define the capture streaming mode. The STREAM mode will send the data to given stream address and port. And the STANDALONE mode will save the capture file in local folder.","title":"Packet Capture streaming mode"}}},"X509Certificate":{"x-vmw-nsx-module":"CertificateManager","type":"object","properties":{"ecdsa_ec_field_f2mks":{"items":{"type":"integer","format":"int64"},"readOnly":true,"type":"array","description":"The order of the middle term(s) of the reduction polynomial in elliptic curve (EC) | characteristic 2 finite field.| Contents of this array are copied to protect against subsequent modification in ECDSA.","title":"ECDSA Elliptic Curve F2MKS"},"version":{"readOnly":true,"type":"string","description":"Certificate version (default v1)."},"is_ca":{"readOnly":true,"type":"boolean","description":"True if this is a CA certificate."},"signature_algorithm":{"readOnly":true,"type":"string","description":"The algorithm used by the Certificate Authority to sign the certificate."},"ecdsa_public_key_a":{"readOnly":true,"type":"string","description":"The first coefficient of this elliptic curve in ECDSA.","title":"ECDSA Elliptic Curve Public Key A"},"rsa_public_key_exponent":{"readOnly":true,"type":"string","description":"An RSA public key is made up of the modulus and the public exponent. Exponent is a power number."},"ecdsa_ec_field_f2mm":{"readOnly":true,"format":"int64","type":"integer","description":"The first coefficient of this elliptic curve in elliptic curve (EC) | characteristic 2 finite field for ECDSA.","title":"ECDSA Elliptic Curve F2MM"},"issuer_cn":{"readOnly":true,"type":"string","description":"The certificate issuer's common name."},"subject_cn":{"readOnly":true,"type":"string","description":"The certificate owner's common name."},"ecdsa_public_key_order":{"readOnly":true,"type":"string","description":"The order of generator G in ECDSA.","title":"ECDSA Elliptic Curve Public Key Order"},"ecdsa_ec_field_f2mrp":{"readOnly":true,"type":"string","description":"The value whose i-th bit corresponds to the i-th coefficient of the reduction polynomial | in elliptic curve (EC) characteristic 2 finite field for ECDSA.","title":"ECDSA Elliptic Curve F2MRP"},"public_key_length":{"readOnly":true,"type":"integer","description":"Size measured in bits of the public/private keys used in a cryptographic algorithm.","format":"int64"},"not_before":{"description":"The time in epoch milliseconds at which the certificate becomes valid.","format":"int64","readOnly":true,"type":"integer"},"ecdsa_ec_field_f2pp":{"readOnly":true,"type":"string","description":"The specified prime for the elliptic curve prime finite field in ECDSA.","title":"ECDSA Elliptic Curve F2PP"},"issuer":{"readOnly":true,"type":"string","description":"The certificate issuers complete distinguished name."},"ecdsa_public_key_b":{"readOnly":true,"type":"string","description":"The second coefficient of this elliptic curve in ECDSA.","title":"ECDSA Elliptic Curve Public Key B"},"rsa_public_key_modulus":{"readOnly":true,"type":"string","description":"An RSA public key is made up of the modulus and the public exponent. Modulus is wrap around number."},"dsa_public_key_y":{"readOnly":true,"type":"string","description":"One of the DSA cryptogaphic algorithm's strength parameters."},"ecdsa_public_key_cofactor":{"readOnly":true,"format":"int64","type":"integer","description":"The co-factor in ECDSA.","title":"ECDSA Elliptic Curve Public Key Cofactor"},"not_after":{"description":"The time in epoch milliseconds at which the certificate becomes invalid.","format":"int64","readOnly":true,"type":"integer"},"dsa_public_key_q":{"readOnly":true,"type":"string","description":"One of the DSA cryptogaphic algorithm's strength parameters, sub-prime."},"dsa_public_key_p":{"readOnly":true,"type":"string","description":"One of the DSA cryptogaphic algorithm's strength parameters, prime."},"ecdsa_public_key_generator_y":{"readOnly":true,"type":"string","description":"Y co-ordinate of G (the generator which is also known as the base point) in ECDSA.","title":"ECDSA Elliptic Curve Public Key Y"},"ecdsa_public_key_generator_x":{"readOnly":true,"type":"string","description":"X co-ordinate of G (the generator which is also known as the base point) in ECDSA.","title":"ECDSA Elliptic Curve Public Key X"},"public_key_algo":{"readOnly":true,"type":"string","description":"Cryptographic algorithm used by the public key for data encryption.","title":"Public Key Algorithm"},"is_valid":{"readOnly":true,"type":"boolean","description":"True if this certificate is valid."},"ecdsa_public_key_seed":{"items":{"type":"string"},"readOnly":true,"type":"array","description":"The bytes used during curve generation for later validation in ECDSA.| Contents of this array are copied to protect against subsequent modification.","title":"ECDSA Elliptic Curve Public Key Seed"},"signature":{"readOnly":true,"type":"string","description":"The signature value(the raw signature bits) used for signing and validate the cert."},"serial_number":{"readOnly":true,"type":"string","description":"Certificate's serial number."},"dsa_public_key_g":{"readOnly":true,"type":"string","description":"One of the DSA cryptogaphic algorithm's strength parameters, base."},"subject":{"readOnly":true,"type":"string","description":"The certificate owners complete distinguished name."},"ecdsa_ec_field":{"readOnly":true,"enum":["F2M","FP"],"type":"string","description":"Represents an elliptic curve (EC) finite field in ECDSA.","title":"ECDSA Elliptic Curve Finite Field"},"ecdsa_curve_name":{"readOnly":true,"type":"string","description":"The Curve name for the ECDSA certificate.","title":"ECDSA Curve Name"}}},"L2VPNSessionRemoteMacs":{"x-vmw-nsx-module":"L2VPNStatistics","type":"object","description":"Remote MAC addresses for all logical switches for a L2VPN session.","properties":{"remote_mac_addresses":{"items":{"$ref":"#/definitions/L2VPNSessionRemoteMacsForLS"},"readOnly":true,"type":"array","description":"List MAC addresses for all logical switch for a particular L2VPN session.","title":"Remote MAC addresses for all logical switches"},"display_name":{"readOnly":true,"type":"string","description":"L2VPN display name.","title":"Display name"},"session_id":{"readOnly":true,"type":"string","description":"L2VPN session identifier.","title":"Session identifier"}},"title":"Remote MAC addresses list"},"UpgradeUnitGroupStatus":{"x-vmw-nsx-module":"Upgrade","type":"object","properties":{"status":{"readOnly":true,"enum":["SUCCESS","FAILED","IN_PROGRESS","NOT_STARTED","PAUSING","PAUSED"],"type":"string","description":"Upgrade status of upgrade unit group","title":"Upgrade status of upgrade unit group"},"upgrade_unit_count":{"readOnly":true,"format":"int32","type":"integer","description":"Number of upgrade units in the group","title":"Number of upgrade units in the group"},"failed_count":{"readOnly":true,"format":"int32","type":"integer","description":"Number of nodes in the upgrade unit group that failed upgrade","title":"Number of nodes in the upgrade unit group that failed upgrade"},"percent_complete":{"readOnly":true,"type":"number","description":"Indicator of upgrade progress in percentage","title":"Indicator of upgrade progress in percentage"},"group_id":{"readOnly":true,"type":"string","description":"Identifier for upgrade unit group","title":"UUID of upgrade unit group"},"group_name":{"readOnly":true,"type":"string","description":"Name of the upgrade unit group","title":"Upgrade unit group Name"}}},"AuthenticationPolicyProperties":{"x-vmw-nsx-module":"MISSING_MODULE","allOf":[{"$ref":"#/definitions/Resource"},{"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"api_failed_auth_reset_period":{"description":"In order to trigger an account lockout, all authentication failures must occur in this time window. If the reset period expires, the failed login count is reset to zero. Only applies to NSX Manager nodes. Ignored on other node types.","format":"int64","default":900,"title":"Period, in seconds, for authentication failures to trigger lockout","minimum":0,"type":"integer"},"minimum_password_length":{"description":"Minimum number of characters required in account passwords","format":"int64","default":8,"title":"Minimum number of characters required in account passwords","minimum":8,"type":"integer"},"cli_failed_auth_lockout_period":{"description":"Once a lockout occurs, the account remains locked out of the CLI for this time period. While the lockout period is in effect, additional authentication attempts restart the lockout period, even if a valid password is specified.","format":"int64","default":900,"title":"Lockout period in seconds","minimum":0,"type":"integer"},"api_max_auth_failures":{"description":"Only applies to NSX Manager nodes. Ignored on other node types.","format":"int64","default":5,"title":"Number of authentication failures that trigger API lockout","minimum":0,"type":"integer"},"api_failed_auth_lockout_period":{"description":"Once a lockout occurs, the account remains locked out of the API for this time period. Only applies to NSX Manager nodes. Ignored on other node types.","format":"int64","default":900,"title":"Lockout period in seconds","minimum":0,"type":"integer"},"cli_max_auth_failures":{"description":"Number of authentication failures that trigger CLI lockout","format":"int64","default":5,"title":"Number of authentication failures that trigger CLI lockout","minimum":0,"type":"integer"}}}],"description":"Configuration of authentication policies for the NSX node","title":"Configuration of authentication policies for the NSX node"},"UpgradeCheckFailureListResult":{"x-vmw-nsx-module":"Upgrade","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"Upgrade","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/UpgradeCheckFailure"},"type":"array","description":"Collection of pre/post-upgrade check failures","title":"Collection of pre/post-upgrade check failures"}}}]},"PreVmGroupMigrationSpec":{"description":"Migration spec for a VM group that will be used in pre VM group migration step.","title":"Migration spec for a VM group","required":["group_id","vm_instance_ids"],"x-vmw-nsx-module":"Migration","type":"object","properties":{"allow_override":{"default":false,"readOnly":false,"type":"boolean","description":"Flag to indicate whether to re-run the pre migrate steps for the VM group if they are already run before.","title":"Flag for re-running the pre migrate steps"},"group_id":{"readOnly":false,"type":"string","description":"User defined VM group id that must be unique among all VM groups ids.","title":"User defined VM group id"},"vm_instance_ids":{"items":{"type":"string"},"readOnly":false,"type":"array","description":"List of VM instance uuids that can be found in VC inventory.","title":"List of VM instance uuids"}}},"DhcpFilter":{"description":"DHCP filtering configuration","title":"DHCP filtering configuration","required":["client_block_enabled","server_block_enabled"],"x-vmw-nsx-module":"SwitchSecuritySwitchingProfile","type":"object","properties":{"client_block_enabled":{"readOnly":false,"type":"boolean","description":"Indicates whether DHCP client blocking is enabled","title":"Indicates whether DHCP client blocking is enabled"},"v6_client_block_enabled":{"default":false,"readOnly":false,"type":"boolean","description":"Indiactes whether DHCP v6 client blocking is enabled","title":"Indiactes whether DHCP v6 client blocking is enabled"},"server_block_enabled":{"readOnly":false,"type":"boolean","description":"Indicates whether DHCP server blocking is enabled","title":"Indicates whether DHCP server blocking is enabled"},"v6_server_block_enabled":{"default":false,"readOnly":false,"type":"boolean","description":"Indiactes whether DHCP V6 server blocking is enabled","title":"Indiactes whether DHCP V6 server blocking is enabled"}}},"StaticHopBfdPeer":{"x-vmw-nsx-module":"Routing","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"Routing","required":["peer_ip_address"],"type":"object","properties":{"source_addresses":{"items":{"description":"IPv4 or IPv6 address","format":"ip","type":"string"},"type":"array","description":"BFD peers will be created from all these source addresses to this neighbour.","maxItems":8,"title":"Array of Logical Router Uplink IP Addresses"},"bfd_config":{"$ref":"#/definitions/BfdConfigParameters"},"enabled":{"default":true,"type":"boolean","description":"Indicate BFD peer is enabled or disabled. Default is true.","title":"status of BFD peer"},"peer_ip_address":{"description":"IP address of BFD peer. This should be same as next hop IP address.","format":"ip","type":"string"}}}]},"RedistributionRuleList":{"x-vmw-nsx-module":"Routing","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"Routing","type":"object","properties":{"rules":{"description":"List of redistribution rules.\nUser needs to re-order rules to change the priority.\n","title":"List of redistribution rules.\nUser needs to re-order rules to change the priority.\n","default":[],"items":{"$ref":"#/definitions/RedistributionRule"},"minItems":0,"maxItems":5,"type":"array"},"logical_router_id":{"readOnly":true,"type":"string","description":"Logical router id","title":"Logical router id"}}}]},"TunnelProperties":{"x-vmw-nsx-module":"Tunnel","allOf":[{"$ref":"#/definitions/Resource"},{"x-vmw-nsx-module":"Tunnel","type":"object","properties":{"status":{"readOnly":true,"enum":["UP","DOWN","UNKNOWN"],"type":"string","description":"Status of tunnel","title":"Status of tunnel"},"egress_interface":{"readOnly":true,"type":"string","description":"Corresponds to the interface where local_ip_address is routed.","title":"Name of local transport interface carrying tunnel traffic"},"remote_node_id":{"readOnly":true,"type":"string","description":"UUID of the remote transport node","title":"UUID of the remote transport node"},"bfd":{"$ref":"#/definitions/BFDProperties"},"local_ip":{"readOnly":true,"format":"ip","type":"string","description":"Local IP address of tunnel","title":"Local IP address of tunnel"},"last_updated_time":{"description":"Time at which the Tunnel status has been fetched last time.","format":"int64","readOnly":true,"type":"integer"},"name":{"readOnly":true,"type":"string","description":"Name of tunnel","title":"Name of tunnel"},"remote_node_display_name":{"readOnly":true,"type":"string","description":"Represents the display name of the remote transport node at the other end of the tunnel.","title":"Display name of the remote transport node"},"encap":{"readOnly":true,"enum":["STT","VXLAN","GENEVE","NONE","UNKNOWN_ENCAP"],"type":"string","description":"Tunnel encap","title":"Tunnel encap"},"latency_type":{"readOnly":true,"enum":["UNKNOWN_LATENCY","VALID","NOT_READY","TIMEOUT"],"type":"string","description":"Latency type.","title":"Latency type"},"latency_value":{"readOnly":true,"format":"int64","type":"integer","description":"The latency value is set only when latency_type is VALID.","title":"Latency value"},"remote_ip":{"readOnly":true,"format":"ip","type":"string","description":"Remote IP address of tunnel","title":"Remote IP address of tunnel"}}}]},"CsrExt":{"x-vmw-nsx-module":"CertificateManager","allOf":[{"$ref":"#/definitions/Csr"},{"x-vmw-nsx-module":"CertificateManager","type":"object","properties":{"extensions":{"$ref":"#/definitions/CsrExtensions"}}}],"description":"Extended certificate signing request body","title":"Extended certificate signing request body"},"ControlClusteringConfig":{"x-vmw-nsx-module":"ClusterNodeVMDeployment","allOf":[{"$ref":"#/definitions/ClusteringConfig"},{"x-vmw-nsx-module":"ClusterNodeVMDeployment","type":"object","properties":{"join_to_existing_cluster":{"type":"boolean","description":"Specifies whether or not the cluster node VM should try to join to\nthe existing control cluster or initialize a new one.\nOnly required in uncertainty case, i.e. when there are manually-\ndeployed controllers that are registered but not connected to the\ncluster and no auto-deployed controllers are part of the cluster.\n","title":"Flag to identify the type of clustering"},"shared_secret":{"type":"string","description":"Shared secret to be used when joining the cluster node VM to a control\ncluster or for initializing a new cluster with the VM.\nMust contain at least 4 unique characters and be at least 6 characters\nlong.\n","title":"Cluster's shared secret"}}}],"description":"Config for joining cluster nodes VMs to a control cluster\n","title":"Clustering config for joining control cluster"},"WidgetPlotConfiguration":{"x-vmw-nsx-module":"NsxDashboard","type":"object","description":"Base type for widget plot config.","properties":{"allow_maximize":{"type":"boolean","description":"Allow maximize capability for this widget","title":"Allow maximize capability for this widget"},"condition":{"maxLength":1024,"type":"string","description":"If the condition is met then the given chart config is applied to the widget configuration.","title":"Expression for evaluating condition for this chart config"}},"title":"Base type for widget plot config"},"StaticRouteNextHop":{"x-vmw-nsx-module":"Routing","type":"object","properties":{"blackhole_action":{"description":"Action to be taken on matching packets for NULL routes.","enum":["DISCARD"],"readOnly":true,"type":"string"},"administrative_distance":{"description":"Administrative Distance for the next hop IP","title":"Administrative Distance for the next hop IP","default":1,"format":"int64","maximum":255,"minimum":1,"type":"integer"},"ip_address":{"description":"Next Hop IP","format":"ip","type":"string"},"bfd_enabled":{"default":false,"readOnly":true,"type":"boolean","description":"Status of bfd for this next hop where bfd_enabled = true indicate bfd is enabled for this next hop and bfd_enabled = false indicate bfd peer is disabled or not configured for this next hop.","title":"Status of bfd for this next hop where bfd_enabled = true indicate bfd is enabled for this next hop and bfd_enabled = false indicate bfd peer is disabled or not configured for this next hop."},"logical_router_port_id":{"$ref":"#/definitions/ResourceReference"}}},"ViewList":{"x-vmw-nsx-module":"NsxDashboard","type":"object","description":"Represents a list of views.","properties":{"views":{"items":{"$ref":"#/definitions/View"},"readOnly":true,"type":"array","description":"Array of views","title":"Array of views"}},"title":"List of Views"},"UpgradeHistory":{"x-vmw-nsx-module":"UpgradeTypes","required":["timestamp","target_version","initial_version","upgrade_status"],"type":"object","properties":{"timestamp":{"type":"integer","description":"Timestamp (in milliseconds since epoch) when the upgrade was performed","format":"int64"},"target_version":{"type":"string","description":"Version being upgraded to","title":"Target Version"},"initial_version":{"type":"string","description":"Version before the upgrade started","title":"Initial Version"},"upgrade_status":{"enum":["STARTED","SUCCESS","FAILED"],"type":"string","description":"Status of the upgrade","title":"Status of the upgrade"}}},"SystemHealthPluginProfileList":{"x-vmw-nsx-module":"SystemHealthPlugin","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"SystemHealthPlugin","required":["result_count"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/SystemHealthPluginProfile"},"type":"array","description":"System Health plugin list","title":"System Health plugin list"},"result_count":{"format":"int64","type":"integer","description":"Total plugin count","title":"Total plugin count"}}}]},"BaseHostSwitchProfile":{"x-vmw-nsx-module":"BaseHostSwitchProfile","allOf":[{"$ref":"#/definitions/ManagedResource"},{"discriminator":"resource_type","x-vmw-nsx-module":"BaseHostSwitchProfile","required":["resource_type"],"type":"object","properties":{"required_capabilities":{"items":{"type":"string"},"readOnly":true,"type":"array"},"resource_type":{"description":"Supported HostSwitch profiles.","enum":["UplinkHostSwitchProfile","LldpHostSwitchProfile","NiocProfile","ExtraConfigHostSwitchProfile"],"type":"string"}}}]},"EdgeUpgradeStatus":{"x-vmw-nsx-module":"Upgrade","allOf":[{"$ref":"#/definitions/ComponentUpgradeStatus"},{"x-vmw-nsx-module":"Upgrade","type":"object"}],"description":"Status of edge upgrade","title":"Status of edge upgrade"},"ControllerProfilerProperties":{"x-vmw-nsx-module":"MISSING_MODULE","allOf":[{"$ref":"#/definitions/Resource"},{"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"enabled":{"type":"boolean","description":"True for enabling controller profiler,\nFalse for disabling controller profiler.\n"}}}],"description":"Controller profiler properties","title":"Controller profiler properties"},"NDRAAdvertisedRoute":{"x-vmw-nsx-module":"Routing","required":["subnet"],"type":"object","properties":{"subnet":{"description":"Advertised route subnet\n","format":"ipv6-cidr-block","type":"string"},"route_preference":{"description":"NDRA Route preference. Indicates preference of the router associated\nwith a prefix over others, when multiple identical prefixes (for\ndifferent routers) have been received.\n","default":"MEDIUM","enum":["LOW","MEDIUM","HIGH","RESERVED"],"type":"string"},"route_lifetime":{"description":"Lifetime of advertised route in seconds.\n","title":"Lifetime of advertised route","default":1800,"format":"int64","maximum":65520,"minimum":0,"type":"integer"}}},"PoolMemberGroup":{"x-vmw-nsx-module":"LoadBalancer","required":["grouping_object"],"type":"object","properties":{"grouping_object":{"$ref":"#/definitions/ResourceReference"},"ip_revision_filter":{"default":"IPV4","enum":["IPV4","IPV6","IPV4_IPV6"],"type":"string","description":"Ip revision filter is used to filter IPv4 or IPv6 addresses from the\ngrouping object.\nIf the filter is not specified, both IPv4 and IPv6 addresses would be\nused as server IPs.\nThe link local and loopback addresses would be always filtered out.\n","title":"Filter of ipv4 or ipv6 address of grouping object IP list"},"max_ip_list_size":{"description":"The size is used to define the maximum number of grouping object IP\naddress list. These IP addresses would be used as pool members.\nIf the grouping object includes more than certain number of\nIP addresses, the redundant parts would be ignored and those IP\naddresses would not be treated as pool members.\nIf the size is not specified, one member is budgeted for this dynamic\npool so that the pool has at least one member even if some other\ndynamic pools grow beyond the capacity of load balancer service. Other\nmembers are picked according to available dynamic capacity. The unused\nmembers would be set to DISABLED so that the load balancer system\nitself is not overloaded during runtime.\n","format":"int64","title":"Maximum number of grouping object IP address list","maximum":2147483647,"minimum":0,"type":"integer"},"port":{"description":"If port is specified, all connections will be sent to this port.\nIf unset, the same port the client connected to will be used, it could\nbe overridden by default_pool_member_ports setting in virtual server.\nThe port should not specified for multiple ports case.\n","format":"int32","title":"Pool member port for all IP addresses of the grouping object","maximum":65535,"minimum":1,"type":"integer"},"customized_members":{"items":{"$ref":"#/definitions/PoolMemberSetting"},"readOnly":false,"type":"array","description":"The list is used to show the customized pool member settings. User can\nonly user pool member action API to update the admin state for a specific\nIP address.\n","title":"List of customized pool member settings"}}},"SupportBundleFileTransferProtocol":{"x-vmw-nsx-module":"MISSING_MODULE","required":["ssh_fingerprint","name","authentication_scheme"],"type":"object","properties":{"ssh_fingerprint":{"type":"string","description":"SSH fingerprint of server","title":"SSH fingerprint of server"},"name":{"enum":["SCP","SFTP"],"type":"string","description":"Protocol name","title":"Protocol name"},"authentication_scheme":{"$ref":"#/definitions/SupportBundleFileTransferAuthenticationScheme"}}},"L2VpnService":{"x-vmw-nsx-module":"L2VPN","allOf":[{"$ref":"#/definitions/ManagedResource"},{"required":["logical_router_id"],"x-vmw-nsx-module":"L2VPN","type":"object","properties":{"enable_full_mesh":{"default":false,"type":"boolean","description":"Full mesh topology auto disables traffic replication between connected\npeers. However, this property is deprecated. Please refer enable_hub\nproperty instead to control client to client forwarding via the server.\nThe value of enable_full_mesh will not be used anymore. If enable_hub\nis not provided explicitly, the default value of it will be used.\n","x-deprecated":true,"title":"Enable full mesh topology"},"enable_hub":{"default":false,"type":"boolean","description":"This property only applies in SERVER mode. If set to true,\ntraffic from any client will be replicated to all other clients.\nIf set to false, traffic received from clients is only replicated\nto the local VPN endpoint.\n","title":"Enable client to client forwarding via server"},"logical_router_id":{"type":"string","description":"Logical router id","title":"Logical router id"},"mode":{"default":"SERVER","enum":["SERVER","CLIENT"],"type":"string","description":"Specify an L2VPN service mode as SERVER or CLIENT. L2VPN service\nin SERVER mode requires user to configure L2VPN session explicitly.\nL2VPN service in CLIENT mode can use peercode generated from SERVER\nto configure L2VPN session.\n","title":"L2VPN Service Mode"},"logical_tap_ip_pool":{"items":{"description":"IPv4 CIDR Block","format":"ipv4-cidr-block","type":"string"},"type":"array","description":"IP Pool to allocate local and peer endpoint IPs for L2VpnSession logical Tap.","title":"IP Pool for Logical Taps"}}}],"description":"Defines if service running as server or client Also defines all the common properties for the multiple L2VpnSessions associated with this service.","title":"L2VPN Service"},"Crl":{"x-vmw-nsx-module":"CertificateManager","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"CertificateManager","type":"object","properties":{"details_revoked_by_subject_and_public_key_hash":{"items":{"$ref":"#/definitions/SubjectPublicKeyHash"},"readOnly":true,"type":"array","description":"Certificates revoked by subject and public key hash","title":"Certificates revoked by subject and public key hash"},"details":{"$ref":"#/definitions/X509Crl"},"pem_encoded":{"readOnly":false,"type":"string","description":"PEM encoded CRL data."},"one_crl":{"readOnly":false,"type":"string","description":"JSON-encoded OneCRL-like object","title":"JSON-encoded OneCRL-like object"},"crl_type":{"default":"X509","enum":["OneCRL","X509"],"type":"string","description":"The type of the CRL. It can be \"OneCRL\" or \"X509\" (default).","title":"Type of CRL"},"details_revoked_by_issuer_and_serial_number":{"items":{"$ref":"#/definitions/IssuerSerialNumber"},"readOnly":true,"type":"array","description":"Certificates revoked by issuer and serial number","title":"Certificates revoked by issuer and serial number"}}}]},"BundleUploadPermission":{"x-vmw-nsx-module":"FileUploadFramework","type":"object","description":"Describes whether bundle upload is allowed or not.","properties":{"reason":{"readOnly":true,"type":"string","description":"Reason for not allowing upload."},"upload_allowed":{"readOnly":true,"type":"boolean","description":"Flag indication whether upload is allowed or not.","title":"Bundle upload allowed flag"}},"title":"Permissions for bundle upload"},"VidmInfo":{"x-vmw-nsx-module":"AAA","type":"object","description":"Vidm Info","properties":{"display_name":{"readOnly":true,"type":"string","description":"User's Full Name Or User Group's Display Name","title":"User's Full Name Or User Group's Display Name"},"type":{"readOnly":true,"enum":["remote_user","remote_group"],"type":"string","description":"Type","title":"Type"},"name":{"readOnly":true,"type":"string","description":"Username Or Groupname","title":"Username Or Groupname"}},"title":"Vidm Info"},"NodeMode":{"description":"Possible values of a mode in a \"/config/nsx_appliance_mode\" file","title":"Stub for Nsx node modes","required":["mode_id"],"x-vmw-nsx-module":"ApplianceModes","type":"object","properties":{"mode_id":{"enum":["ON_PREM","SERVICE","VMC","VMC_LOCAL"],"type":"string","description":"Possible enum values in a \"/config/nsx_appliance_mode\" file","title":"Nsx node mode"}}},"DVSConfig":{"description":"The DVS Configuration","title":"The DVS Configuration","required":["name","uplink_port_names"],"x-vmw-nsx-module":"DistributedVirtualSwitch","type":"object","properties":{"name":{"readOnly":false,"type":"string","description":"The DVS name","title":"The DVS name"},"lacp_group_configs":{"items":{"$ref":"#/definitions/LacpGroupConfigInfo"},"readOnly":false,"type":"array","description":"It contains information about VMware specific multiple dynamic LACP groups.\n","title":"Array of Link Aggregation Control Protocol (LACP) configuration"},"host_infra_traffic_res":{"items":{"$ref":"#/definitions/ResourceAllocation"},"readOnly":false,"type":"array","description":"host_infra_traffic_res specifies bandwidth allocation for\nvarious traffic resources.\n","title":"Resource allocation associated with NiocProfile"},"uplink_port_names":{"description":"Names of uplink ports for this DVS.","title":"Uplink port names","minItems":1,"items":{"type":"string"},"readOnly":false,"type":"array"},"uuid":{"readOnly":false,"type":"string","description":"The DVS uuid","title":"The DVS uuid"},"lldp_send_enabled":{"default":false,"type":"boolean","description":"Enabled or disabled sending LLDP packets","title":"Enabled or disabled sending LLDP packets"},"mtu":{"format":"int32","minimum":1600,"type":"integer","description":"Maximum Transmission Unit used for uplinks","title":"Maximum Transmission Unit used for uplinks"}}},"MigrationUnitGroupAggregateInfoListResult":{"x-vmw-nsx-module":"Migration","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"Migration","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/MigrationUnitGroupAggregateInfo"},"readOnly":true,"type":"array","description":"Paged collection of migration status for migration unit groups","title":"Paged collection of migration status for migration unit groups"}}}]},"EdgeClusterMember":{"x-vmw-nsx-module":"EdgeClusters","required":["transport_node_id"],"type":"object","properties":{"member_index":{"readOnly":true,"format":"int32","type":"integer","description":"System generated index for cluster member","title":"System generated index for cluster member"},"display_name":{"type":"string","description":"display name of edge cluster member","title":"display name of edge cluster member"},"description":{"type":"string","description":"description of edge cluster member","title":"description of edge cluster member"},"transport_node_id":{"type":"string","description":"Identifier of the transport node backed by an Edge node","title":"UUID of edge transport node"}}},"PortConnectionEdgeNodeGroup":{"x-vmw-nsx-module":"PortConnection","allOf":[{"$ref":"#/definitions/PortConnectionEntity"},{"required":["logical_router_id"],"x-vmw-nsx-module":"PortConnection","type":"object","properties":{"edge_nodes":{"items":{"$ref":"#/definitions/TransportNode"},"type":"array"},"logical_router_id":{"type":"string","description":"Id of the logical router","title":"Id of the logical router"}}}],"description":"Collection of edge nodes backing a logical router","title":"Collection of edge nodes backing a logical router"},"TnNodeAgentStatusListResult":{"x-vmw-nsx-module":"TnContainerStatus","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"TnContainerStatus","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/TnNodeAgentstatus"},"readOnly":true,"type":"array","description":"Container agent status","title":"Container agent status"}}}],"description":"Container agent status list result","title":"Container agent status list result"},"IdsEventFlowData":{"x-vmw-nsx-module":"IDSMetrics","type":"object","description":"IDS event flow data specific to each IDS\nevent. The data includes source ip, source\nport, destination ip, destination port,\nprotocol, rule id, profile id, and the\naction.\n","properties":{"destination_ip":{"readOnly":true,"type":"string","description":"IP address of the destination VM on the intrusion flow.","title":"IP address of the destination VM"},"protocol":{"readOnly":true,"type":"string","description":"Traffic protocol pertaining to the detected intrusion, could be TCP/UDP etc.","title":"Traffic protocol pertaining to the intrusion"},"bytes_toserver":{"readOnly":true,"format":"int64","type":"integer","description":"Bytes sent to server.","title":"Bytes to server"},"local_vm_ip":{"readOnly":true,"type":"string","description":"IP address of VM on the host where IDS engine is running.","title":"IP address of the local VM"},"profile_id":{"readOnly":true,"type":"string","description":"The IDS profile id that is associated with the IDS rule pertaining to the intrusion event detected.","title":"IDS profile id"},"source_ip":{"readOnly":true,"type":"string","description":"IP address of the source VM on the intrusion flow.","title":"IP address of the source VM"},"client_ip":{"readOnly":true,"type":"string","description":"IP address of the VM that initiated the communication.","title":"IP address of the client VM"},"action_type":{"readOnly":true,"enum":["ALERT","DROP","REJECT","INVALID"],"type":"string","description":"The action pertaining to the detected intrusion. Possible values are ALERT, DROP, REJECT, and INVALID. ALERT - If there is a signature match on the packet, it is allowed to pass but a notification is sent to the user notifying an intrusion was detected. DROP - On a signature match, the packet is silently dropped. An alert is sent to the user that an intrusion was detected. REJECT - On a signature match, the packet is dropped and TCP RST or ICMP error messages (for non-TCP pkts) are sent to the endpoints. An alert is sent to the user that an intrusion was detected. INVALID - If the action doesn't belong to any of the above mentioned categories, it is marked as INVALID.","title":"IDS Event action"},"source_port":{"readOnly":true,"format":"int64","type":"integer","description":"Source port through which traffic was initiated that caused the intrusion to be detected.","title":"Source port"},"bytes_toclient":{"readOnly":true,"format":"int64","type":"integer","description":"Bytes sent to client.","title":"Bytes to client"},"destination_port":{"readOnly":true,"format":"int64","type":"integer","description":"Port on the destination VM where the traffic was sent to.","title":"Destination port"},"rule_id":{"readOnly":true,"format":"int64","type":"integer","description":"The IDS Rule id pertaining to the detected intrusion.","title":"IDS Rule id of detected intrusion"}},"title":"IDS event flow data"},"RouteMapSequence":{"x-vmw-nsx-module":"Routing","required":["action","match_criteria"],"type":"object","properties":{"set_criteria":{"$ref":"#/definitions/RouteMapSequenceSet"},"action":{"description":"Action for the Sequence","enum":["PERMIT","DENY"],"type":"string"},"match_criteria":{"$ref":"#/definitions/RouteMapSequenceMatch"}}},"MACAddressElementListResult":{"x-vmw-nsx-module":"MACSet","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"MACSet","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/MACAddressElement"},"type":"array","description":"MAC address element list","title":"MAC address element list"}}}],"description":"Collection of MAC address elements","title":"Collection of MAC address elements"},"CreateRemoteDirectoryProperties":{"x-vmw-nsx-module":"MISSING_MODULE","allOf":[{"$ref":"#/definitions/CopyRemoteFileProperties"},{"x-vmw-nsx-module":"MISSING_MODULE","required":["protocol"],"type":"object","properties":{"protocol":{"$ref":"#/definitions/SftpProtocol"}}}]},"TnHyperbusStatus":{"x-vmw-nsx-module":"TnContainerStatus","required":["hyperbus_status","transport_node_id"],"type":"object","properties":{"hyperbus_status":{"description":"Display the hyperbus status","enum":["UNKNOWN","HEALTHY","UNHEALTHY","DEGRADED"],"type":"string"},"transport_node_id":{"type":"string","description":"Transport node id.","title":"Transport node id"}}},"LbAppProfile":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/ManagedResource"},{"discriminator":"resource_type","x-vmw-nsx-module":"LoadBalancer","required":["resource_type"],"type":"object","properties":{"resource_type":{"description":"An application profile can be bound to a virtual server\nto specify the application protocol characteristics. It is used to\ninfluence how load balancing is performed. Currently, three types of\napplication profiles are supported: LbFastTCPProfile,\nLbFastUDPProfile and LbHttpProfile.\nLbFastTCPProfile or LbFastUDPProfile is typically\nused when the application is using a custom protocol or a standard protocol\nnot supported by the load balancer. It is also used in cases where the user\nonly wants L4 load balancing mainly because L4 load balancing has much\nhigher performance and scalability, and/or supports connection mirroring.\nLbHttpProfile is used for both HTTP and HTTPS applications.\nThough application rules, if bound to the virtual server, can be used\nto accomplish the same goal, LbHttpProfile is intended to\nsimplify enabling certain common use cases.\nLbHttpProfile is deprecated as NSX-T Load Balancer is deprecated.\n","enum":["LbHttpProfile","LbFastTcpProfile","LbFastUdpProfile"],"type":"string"}}}]},"PluginStatusList":{"x-vmw-nsx-module":"SystemHealthPlugin","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"SystemHealthPlugin","required":["result_count"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/PluginStatus"},"type":"array","description":"System Health plugin status list","title":"System Health plugin status list"},"result_count":{"format":"int64","type":"integer","description":"Total plugin count","title":"Total plugin count"}}}]},"ResourceReference":{"x-vmw-nsx-module":"Common","type":"object","description":"A weak reference to an NSX resource.","properties":{"target_display_name":{"readOnly":true,"maxLength":255,"type":"string","description":"Display name of the NSX resource.","title":"Target display name"},"is_valid":{"readOnly":true,"type":"boolean","description":"Will be set to false if the referenced NSX resource has been deleted.","title":"Target validity"},"target_id":{"readOnly":false,"maxLength":64,"type":"string","description":"Identifier of the NSX resource.","title":"Target ID"},"target_type":{"readOnly":false,"maxLength":255,"type":"string","description":"Type of the NSX resource.","title":"Target type"}}},"LbJwtSymmetricKey":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/LbJwtKey"},{"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{}}],"description":"The key is used to specify the symmetric key which is used to verify the\nsignature of JWT tokens.\n","title":"Specifies the symmetric key used to verify the signature of JWT tokens"},"CrlPemRequestType":{"x-vmw-nsx-module":"CertificateManager","type":"object","description":"Request Type to get a CRL's PEM file.","properties":{"cdp_uri":{"readOnly":true,"maxLength":255,"type":"string","description":"CRL Distribution Point URI where to fetch the CRL.","title":"CDP URI"}},"title":"Request Type to get a CRL's PEM file."},"HostNodeStatusListResult":{"x-vmw-nsx-module":"ComputeCollectionDeployment","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"ComputeCollectionDeployment","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/HostNodeStatus"},"readOnly":true,"type":"array","description":"HostNodeStatus Results","title":"HostNodeStatus Results"}}}],"description":"HostNodeStatus queries result","title":"HostNodeStatus queries result"},"LayoutProperties":{"x-vmw-nsx-module":"NsxDashboard","type":"object","description":"Properties of the layout of a container or widget","properties":{"num_rows":{"format":"int32","type":"integer","description":"Describes the number of rows of grid layout of a container or widget. This property is applicable for grid layout only.","title":"Number of rows of grid"},"num_columns":{"format":"int32","type":"integer","description":"Describes the number of columns of grid layout of a container or widget. This property is applicable for grid layout only.","title":"Number of columns of grid"}},"title":"Layout properties of a container or widget"},"NodeNtpServiceProperties":{"x-vmw-nsx-module":"MISSING_MODULE","allOf":[{"$ref":"#/definitions/NodeServiceProperties"},{"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"service_properties":{"$ref":"#/definitions/NtpServiceProperties"}}}],"description":"Node NTP service properties","title":"Node NTP service properties"},"AddressBindingEntry":{"x-vmw-nsx-module":"LogicalPort","type":"object","description":"An address binding entry is a combination of the IP-MAC-VLAN binding for\na logical port. The address bindings can be obtained via various methods\nlike ARP snooping, DHCP snooping etc. or by user configuration.\n","properties":{"source":{"description":"Source from which the address binding entry was obtained","default":"UNKNOWN","enum":["INVALID","UNKNOWN","USER_DEFINED","ARP_SNOOPING","DHCP_SNOOPING","VM_TOOLS","ND_SNOOPING","DHCPV6_SNOOPING","VM_TOOLS_V6"],"type":"string"},"binding":{"$ref":"#/definitions/PacketAddressClassifier"},"binding_timestamp":{"type":"integer","description":"Timestamp at which the binding was discovered via snooping or manually\nspecified by the user\n","format":"int64"}},"title":"Combination of IP-MAC-VLAN binding"},"LbSslCipherInfo":{"description":"SSL cipher","title":"SSL cipher","required":["is_default","is_secure","cipher"],"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"is_default":{"type":"boolean","description":"Default SSL cipher flag","title":"Default SSL cipher flag"},"is_secure":{"type":"boolean","description":"Secure/insecure SSL cipher flag","title":"Secure/insecure SSL cipher flag"},"cipher_group_labels":{"items":{"description":"SSL cipher group","enum":["BALANCED","HIGH_SECURITY","HIGH_COMPATIBILITY","CUSTOM"],"type":"string"},"type":"array","description":"Several cipher groups might contain the same cipher suite, each cipher\nsuite could have multiple cipher group labels.\n","title":"Cipher group label list"},"cipher":{"description":"SSL cipher","enum":["TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256","TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384","TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA","TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA","TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA","TLS_ECDH_RSA_WITH_AES_256_CBC_SHA","TLS_RSA_WITH_AES_256_CBC_SHA","TLS_RSA_WITH_AES_128_CBC_SHA","TLS_RSA_WITH_3DES_EDE_CBC_SHA","TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA","TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256","TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384","TLS_RSA_WITH_AES_128_CBC_SHA256","TLS_RSA_WITH_AES_128_GCM_SHA256","TLS_RSA_WITH_AES_256_CBC_SHA256","TLS_RSA_WITH_AES_256_GCM_SHA384","TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA","TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256","TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256","TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384","TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384","TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA","TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256","TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256","TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384","TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384","TLS_ECDH_RSA_WITH_AES_128_CBC_SHA","TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256","TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256","TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384","TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384"],"type":"string"}}},"NodeHttpServiceProperties":{"x-vmw-nsx-module":"MISSING_MODULE","allOf":[{"$ref":"#/definitions/NodeServiceProperties"},{"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"service_properties":{"$ref":"#/definitions/HttpServiceProperties"}}}],"description":"Node HTTP service properties","title":"Node HTTP service properties"},"BackupOverview":{"x-vmw-nsx-module":"BackupConfiguration","allOf":[{"$ref":"#/definitions/ClusterBackupInfoListResult"},{"required":["current_backup_operation_status","backup_operation_history","backup_config","restore_status"],"x-vmw-nsx-module":"BackupConfiguration","type":"object","properties":{"current_backup_operation_status":{"$ref":"#/definitions/CurrentBackupOperationStatus"},"backup_operation_history":{"$ref":"#/definitions/BackupOperationHistory"},"backup_config":{"$ref":"#/definitions/BackupConfiguration"},"restore_status":{"$ref":"#/definitions/ClusterRestoreStatus"}}}],"description":"Data for a single backup/restore card","title":"Backup overview"},"IpAddressInfo":{"x-vmw-nsx-module":"Inventory","type":"object","description":"Ipaddress information of the fabric node.","properties":{"source":{"readOnly":true,"enum":["VM_TOOLS"],"type":"string","description":"Source of the ipaddress information.","title":"Source of the ipaddress information."},"ip_addresses":{"items":{"description":"IPv4 or IPv6 address","format":"ip","type":"string"},"readOnly":true,"type":"array","description":"IP Addresses of the the virtual network interface, as discovered in the source.","title":"IP Addresses of the the virtual network interface, as discovered in the source."}},"title":"Ipaddress information of the fabric node."},"IpfixCollector":{"x-vmw-nsx-module":"Ipfix","required":["collector_ip_address"],"type":"object","properties":{"collector_ip_address":{"description":"IP address for the IPFIX collector","format":"ip","type":"string"},"collector_port":{"description":"Port for the IPFIX collector","title":"Port for the IPFIX collector","default":4739,"format":"int32","maximum":65535,"minimum":0,"type":"integer"}}},"RateLimits":{"x-vmw-nsx-module":"SwitchSecuritySwitchingProfile","type":"object","description":"Enables traffic limit for incoming/outgoing broadcast and multicast packets. Use 0 to disable rate limiting for a specific traffic type","properties":{"rx_multicast":{"description":"Incoming multicast traffic limit in packets per second","title":"Incoming multicast traffic limit in packets per second","default":0,"format":"int32","readOnly":false,"minimum":0,"type":"integer"},"tx_multicast":{"description":"Outgoing multicast traffic limit in packets per second","title":"Outgoing multicast traffic limit in packets per second","default":0,"format":"int32","readOnly":false,"minimum":0,"type":"integer"},"enabled":{"default":false,"readOnly":false,"type":"boolean","description":"Whether rate limiting is enabled","title":"Whether rate limiting is enabled"},"tx_broadcast":{"description":"Outgoing broadcast traffic limit in packets per second","title":"Outgoing broadcast traffic limit in packets per second","default":0,"format":"int32","readOnly":false,"minimum":0,"type":"integer"},"rx_broadcast":{"description":"Incoming broadcast traffic limit in packets per second","title":"Incoming broadcast traffic limit in packets per second","default":0,"format":"int32","readOnly":false,"minimum":0,"type":"integer"}},"title":"Rate limiting configuration"},"FirewallSessionTimerProfile":{"x-vmw-nsx-module":"FirewallProfile","allOf":[{"$ref":"#/definitions/BaseFirewallProfile"},{"required":["tcp_closed","tcp_opening","udp_single","tcp_finwait","tcp_first_packet","tcp_closing","tcp_established","udp_multiple","icmp_error_reply","udp_first_packet","icmp_first_packet"],"x-vmw-nsx-module":"FirewallProfile","type":"object","properties":{"tcp_closed":{"description":"The timeout value of connection in seconds after one endpoint sends an RST. The default value for Edges (i.e, Gateway, or Logical Router) may be different than Distributed Firewall hosts.","title":"Timeout after RST","default":20,"format":"int64","maximum":4320000,"readOnly":false,"minimum":10,"type":"integer"},"tcp_opening":{"description":"The timeout value of connection in seconds after a second packet has been transferred. The default value for Edges (i.e, Gateway, or Logical Router) may be different than Distributed Firewall hosts.","title":"Connection timout after second packet","default":30,"format":"int64","maximum":4320000,"readOnly":false,"minimum":10,"type":"integer"},"udp_single":{"description":"The timeout value of connection in seconds if the source host sends more than one packet but the destination host has never sent one back. The default value for Edges (i.e, Gateway, or Logical Router) may be different than Distributed Firewall hosts.","title":"Connection timeout for destination","default":30,"format":"int64","maximum":4320000,"readOnly":false,"minimum":10,"type":"integer"},"tcp_finwait":{"description":"The timeout value of connection in seconds after both FINs have been exchanged and connection is closed. The default value for Edges (i.e, Gateway, or Logical Router) may be different than Distributed Firewall hosts.","title":"Timeout after FINs exchanged","default":45,"format":"int64","maximum":4320000,"readOnly":false,"minimum":10,"type":"integer"},"tcp_first_packet":{"description":"The timeout value of connection in seconds after the first packet has been sent. The default value for Edges (i.e, Gateway, or Logical Router) may be different than Distributed Firewall hosts.","title":"Connection timout after first packet","default":120,"format":"int64","maximum":4320000,"readOnly":false,"minimum":10,"type":"integer"},"tcp_closing":{"description":"The timeout value of connection in seconds after the first FIN has been sent. The default value for Edges (i.e, Gateway, or Logical Router) may be different than Distributed Firewall hosts.","title":"Timeout after first TN","default":120,"format":"int64","maximum":4320000,"readOnly":false,"minimum":10,"type":"integer"},"tcp_established":{"description":"The timeout value of connection in seconds once the connection has become fully established. The default value for Edges (i.e, Gateway, or Logical Router) may be different than Distributed Firewall hosts.","title":"Connection timeout","default":43200,"format":"int64","maximum":4320000,"readOnly":false,"minimum":120,"type":"integer"},"udp_multiple":{"description":"The timeout value of connection in seconds if both hosts have sent packets. The default value for Edges (i.e, Gateway, or Logical Router) may be different than Distributed Firewall hosts.","title":"Timeout after hosts sent packet","default":60,"format":"int64","maximum":4320000,"readOnly":false,"minimum":10,"type":"integer"},"icmp_error_reply":{"description":"The timeout value for the connection after an ICMP error came back in response to an ICMP packet. The default value for Edges (i.e, Gateway, or Logical Router) may be different than Distributed Firewall hosts.","title":"Timeout after ICMP error","default":10,"format":"int64","maximum":4320000,"readOnly":false,"minimum":10,"type":"integer"},"udp_first_packet":{"description":"The timeout value of connection in seconds after the first packet. This will be the initial timeout for the new UDP flow. The default value for Edges (i.e, Gateway, or Logical Router) may be different than Distributed Firewall hosts.","title":"Connection timout after first packet","default":60,"format":"int64","maximum":4320000,"readOnly":false,"minimum":10,"type":"integer"},"icmp_first_packet":{"description":"The timeout value of connection in seconds after the first packet. This will be the initial timeout for the new ICMP flow. The default value for Edges (i.e, Gateway, or Logical Router) may be different than Distributed Firewall hosts.","title":"First packet connection timeout","default":20,"format":"int64","maximum":4320000,"readOnly":false,"minimum":10,"type":"integer"}}}],"description":"A profile holding TCP, UDP and ICMP session timeout configuration.","title":"Firewall Session timeout profile"},"SolutionConfig":{"x-vmw-nsx-module":"Nxgi","allOf":[{"$ref":"#/definitions/ManagedResource"},{"required":["solution_id","listen_port","control_ip"],"x-vmw-nsx-module":"Nxgi","type":"object","properties":{"service_id":{"readOnly":true,"type":"string","description":"The service to which the solution config belongs.","title":"Service Id"},"solution_id":{"readOnly":false,"type":"string","description":"Partner needs to specify Solution Id assigned by VMware.","title":"Solution Id"},"listen_port":{"description":"Partner needs to specify their port on which their solution application which consumes NXGI EPSec library listens.","title":"Port","format":"int32","maximum":48655,"readOnly":false,"minimum":48651,"type":"integer"},"control_ip":{"description":"Partner needs to specify their assigned control IP with which they have configured their OVFs.","format":"ipv4","readOnly":false,"type":"string"}}}],"description":"Solution Config would contain Vendor specific information required for configuring the NXGI partner Service after deployment.","title":"Solution Configuration Info"},"ErrorInfo":{"x-vmw-nsx-module":"InventoryCmObj","type":"object","description":"Error information","properties":{"timestamp":{"description":"Timestamp when the error occurred","format":"int64","readOnly":true,"type":"integer"},"error_message":{"readOnly":true,"type":"string","description":"Error message","title":"Error message"},"error_code":{"readOnly":false,"format":"int32","type":"integer","description":"Error code of the error.","title":"Error code"}},"title":"Error information"},"CapacityUsageResponse":{"x-vmw-nsx-module":"CapacityDashboard","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"CapacityDashboard","required":["capacity_usage","meta_info"],"type":"object","properties":{"capacity_usage":{"items":{"$ref":"#/definitions/CapacityDashboardUsage"},"type":"array","description":"List of capacity usage for NSX Objects","title":"List of capacity usage for NSX Objects"},"meta_info":{"type":"object","description":"Meta data for capacity usage statistics","title":"Meta data for capacity usage statistics"},"unreported_usage_types":{"items":{"type":"string"},"type":"array","description":"Types for which usage data was not reported","title":"Unreported usage types"}}}]},"FirewallSection":{"x-vmw-nsx-module":"Firewall","allOf":[{"$ref":"#/definitions/DSSection"},{"x-vmw-nsx-module":"Firewall","type":"object","properties":{"category":{"readOnly":true,"type":"string","description":"Category from policy framework.","title":"Section category"},"enforced_on":{"readOnly":true,"type":"string","description":"This attribute represents enforcement point of firewall section. For example, firewall section enforced on logical port with attachment type bridge endpoint will have 'BRIDGEENDPOINT' value, firewall section enforced on logical router will have 'LOGICALROUTER' value and rest have 'VIF' value.","title":"Firewall Section Enforcement type"},"locked":{"default":false,"readOnly":true,"type":"boolean","description":"Section is locked/unlocked.","title":"Section Locked"},"tcp_strict":{"default":false,"type":"boolean","description":"If TCP strict is enabled on a section and a packet matches rule in it, the following check will be performed. If the packet does not belong to an existing session, the kernel will check to see if the SYN flag of the packet is set. If it is not, then it will drop the packet.","title":"TCP Strict"},"lock_modified_by":{"readOnly":true,"type":"string","description":"ID of the user who last modified the lock for the section.","title":"Lock modified by user"},"lock_modified_time":{"description":"Section locked/unlocked time in epoch milliseconds.","format":"int64","readOnly":true,"type":"integer"},"priority":{"readOnly":true,"format":"int64","type":"integer","description":"Priority of current section with respect to other sections. In case the field is empty, the list section api should be used to get section priority.","title":"Section priority"},"firewall_schedule":{"$ref":"#/definitions/ResourceReference"},"comments":{"readOnly":true,"type":"string","description":"Comments for section lock/unlock.","title":"Section lock/unlock comments"},"autoplumbed":{"default":false,"readOnly":true,"type":"boolean","description":"This flag indicates whether it is an auto-plumbed section that is associated to a LogicalRouter. Auto-plumbed sections are system owned and cannot be updated via the API.","title":"Tells if a section is auto-plumbed or not"}}}]},"ContainerConfiguration":{"x-vmw-nsx-module":"NsxDashboard","allOf":[{"$ref":"#/definitions/WidgetConfiguration"},{"x-vmw-nsx-module":"NsxDashboard","type":"object","properties":{"widgets":{"minItems":0,"items":{"$ref":"#/definitions/WidgetItem"},"type":"array","description":"If not specified, creates an empty container.","title":"Widgets held by the container"},"layout":{"$ref":"#/definitions/Layout"},"labels":{"minItems":0,"items":{"$ref":"#/definitions/Label"},"type":"array","description":"Labels for the container.","title":"Labels"},"navigation":{"maxLength":1024,"type":"string","description":"Hyperlink of the specified UI page that provides details.","title":"Navigation to a specified UI page"},"header":{"$ref":"#/definitions/Header"}}}],"description":"Represents a container to group widgets that belong to a common category or have a common purpose.","title":"Container that holds widgets"},"FirewallStats":{"x-vmw-nsx-module":"FirewallStatsRule","allOf":[{"$ref":"#/definitions/Resource"},{"x-vmw-nsx-module":"FirewallStatsRule","type":"object","properties":{"total_session_count":{"readOnly":true,"format":"int64","type":"integer","description":"Aggregated number of sessions processed by the all firewall rules. This is aggregated statistic which are computed with lower frequency compared to individual generic rule statistics. It may have a computation delay up to 15 minutes in response to this API.","title":"Total sessions count"},"popularity_index":{"readOnly":true,"format":"int64","type":"integer","description":"This is calculated by sessions count divided by age of the rule.","title":"The index of the popularity of firewall rule"},"l7_accept_count":{"readOnly":true,"format":"int64","type":"integer","description":"Aggregated number of L7 Profile Accepted counters received by the rule.","title":"L7 Accept count"},"max_session_count":{"readOnly":true,"format":"int64","type":"integer","description":"Maximum value of sessions count of all firewall rules of the type. This is aggregated statistic which are computed with lower frequency compared to generic rule statistics. It may have a computation delay up to 15 minutes in response to this API.","title":"Maximum sessions count"},"byte_count":{"readOnly":true,"format":"int64","type":"integer","description":"Aggregated number of bytes processed by the rule.","title":"Bytes count"},"l7_reject_with_response_count":{"readOnly":true,"format":"int64","type":"integer","description":"Aggregated number of L7 Profile Rejected with Response counters received by the rule.","title":"L7 Reject with response count"},"l7_reject_count":{"readOnly":true,"format":"int64","type":"integer","description":"Aggregated number of L7 Profile Rejected counters received by the rule.","title":"L7 Reject count"},"session_count":{"readOnly":true,"format":"int64","type":"integer","description":"Aggregated number of sessions processed by the rule.","title":"Sessions count"},"packet_count":{"readOnly":true,"format":"int64","type":"integer","description":"Aggregated number of packets processed by the rule.","title":"Packets count"},"hit_count":{"readOnly":true,"format":"int64","type":"integer","description":"Aggregated number of hits received by the rule.","title":"Hits count"},"max_popularity_index":{"readOnly":true,"format":"int64","type":"integer","description":"Maximum value of popularity index of all firewall rules of the type. This is aggregated statistic which are computed with lower frequency compared to individual generic rule statistics. It may have a computation delay up to 15 minutes in response to this API.","title":"The maximum popularity index"},"rule_id":{"readOnly":true,"type":"string","description":"Rule Identifier of the Firewall rule. This is a globally unique number.","title":"Firewall rule Id"}}}]},"ConfigurationState":{"x-vmw-nsx-module":"Common","type":"object","description":"Describes status of configuration of an entity","properties":{"state":{"readOnly":true,"enum":["pending","in_progress","success","failed","partial_success","orphaned","unknown","error","in_sync","NOT_AVAILABLE","VM_DEPLOYMENT_QUEUED","VM_DEPLOYMENT_IN_PROGRESS","VM_DEPLOYMENT_FAILED","VM_POWER_ON_IN_PROGRESS","VM_POWER_ON_FAILED","REGISTRATION_PENDING","NODE_NOT_READY","NODE_READY","VM_POWER_OFF_IN_PROGRESS","VM_POWER_OFF_FAILED","VM_UNDEPLOY_IN_PROGRESS","VM_UNDEPLOY_FAILED","VM_UNDEPLOY_SUCCESSFUL","EDGE_CONFIG_ERROR","VM_DEPLOYMENT_RESTARTED","REGISTRATION_FAILED","TRANSPORT_NODE_SYNC_PENDING","TRANSPORT_NODE_CONFIGURATION_MISSING","EDGE_HARDWARE_NOT_SUPPORTED","MULTIPLE_OVERLAY_TZS_NOT_SUPPORTED","TN_OVERLAY_TZ_IN_USE_BY_EDGE_CLUSTER","TZ_ENDPOINTS_NOT_SPECIFIED","NO_PNIC_PREPARED_IN_EDGE","APPLIANCE_INTERNAL_ERROR","VTEP_DHCP_NOT_SUPPORTED","UNSUPPORTED_HOST_SWITCH_PROFILE","UPLINK_HOST_SWITCH_PROFILE_NOT_SPECIFIED","HOSTSWITCH_PROFILE_NOT_FOUND","LLDP_SEND_ENABLED_NOT_SUPPORTED","UNSUPPORTED_NAMED_TEAMING_POLICY","LBSRCID_NOT_SUPPORTED_FOR_EDGE_VM","LACP_NOT_SUPPORTED_FOR_EDGE_VM","STANDBY_UPLINKS_NOT_SUPPORTED_FOR_EDGE_VM","MULTIPLE_ACTIVE_UPLINKS_NOT_SUPPORTED_FOR_EDGE","UNSUPPORTED_LACP_LB_ALGO_FOR_NODE","EDGE_NODE_VERSION_NOT_SUPPORTED","NO_PNIC_SPECIFIED_IN_TN","INVALID_PNIC_DEVICE_NAME","TRANSPORT_NODE_READY","VM_NETWORK_EDIT_PENDING","UNSUPPORTED_DEFAULT_TEAMING_POLICY","MPA_DISCONNECTED","VM_RENAME_PENDING","VM_CONFIG_EDIT_PENDING","VM_NETWORK_EDIT_FAILED","VM_RENAME_FAILED","VM_CONFIG_EDIT_FAILED","VM_CONFIG_DISCREPANCY","VM_NODE_REFRESH_FAILED","VM_PLACEMENT_REFRESH_FAILED","REGISTRATION_TIMEDOUT","REPLACE_FAILED","UPLINK_FROM_TEAMING_POLICY_NOT_MAPPED","LOGICAL_SWITCH_NAMED_TEAMING_HAS_NO_PNIC_BACKING","DELETE_VM_IN_REDEPLOY_FAILED","DEPLOY_VM_IN_REDEPLOY_FAILED","INSUFFICIENT_RESOURCES_IN_EDGE_NODE_FOR_SERVICE","VM_RESOURCE_RESERVATION_FAILED","DUPLICATE_PNICS_IN_TEAMINGS_WITH_MULTIPLE_UPLINKS_AND_FAILOVER_ORDER","DUPLICATE_VLANS_SHARING_SAME_PNICMULTIPLE_UPLINKS_IN_NAMED_TEAMING_NOT_SUPPORTED_IF_UPLINK_IN_DEFAULT_TEAMING","EDGE_NODE_SETTINGS_MISMATCH_RESOLVE","EDGE_VM_VSPHERE_SETTINGS_MISMATCH_RESOLVE","EDGE_NODE_SETTINGS_AND_VSPHERE_SETTINGS_ARE_CHANGED_RESOLVE","EDGE_VSPHERE_LOCATION_MISMATCH_RESOLVE","COMPUTE_MANAGER_NOT_FOUND"],"type":"string","description":"Gives details of state of desired configuration.\nAdditional enums with more details on progress/success/error states\nare sent for edge node. The success states are NODE_READY and\nTRANSPORT_NODE_READY, pending states are {VM_DEPLOYMENT_QUEUED,\nVM_DEPLOYMENT_IN_PROGRESS, REGISTRATION_PENDING} and other values\nindicate failures.\n\"in_sync\" state indicates that the desired configuration has been\nreceived by the host to which it applies, but is not yet in effect.\nWhen the configuration is actually in effect, the state will\nchange to \"success\".\nPlease note, failed state is deprecated.\n","title":"Overall state of desired configuration"},"details":{"items":{"$ref":"#/definitions/ConfigurationStateElement"},"readOnly":true,"type":"array","description":"Array of configuration state of various sub systems","title":"Array of configuration state of various sub systems"},"failure_code":{"readOnly":true,"format":"int64","type":"integer","description":"Error code","title":"Error code"},"failure_message":{"readOnly":true,"type":"string","description":"Error message in case of failure","title":"Error message in case of failure"}},"title":"Describes status of configuration of an entity"},"UpgradeCheck":{"description":"Check to identify potential pre/post-upgrade issues","title":"Pre/post-upgrade check","required":["component_type"],"x-vmw-nsx-module":"Upgrade","type":"object","properties":{"status":{"readOnly":true,"enum":["SUCCESS","FAILURE","WARNING"],"type":"string","description":"Status of pre/post-upgrade check","title":"Status of pre/post-upgrade check"},"failures":{"items":{"$ref":"#/definitions/UpgradeCheckFailureMessage"},"readOnly":true,"type":"array","description":"List of failures","title":"List of failures"},"display_name":{"readOnly":false,"type":"string","description":"Name of the pre/post-upgrade check","title":"Name of the pre/post-upgrade check"},"failure_messages":{"description":"List of failure messages. This field is deprecated now. Please use failures instead.","title":"List of failure messages","items":{"type":"string"},"x-deprecated":true,"readOnly":true,"type":"array"},"component_type":{"readOnly":false,"type":"string","description":"Component type","title":"Component type"}}},"IPSecVPNSessionStatistics":{"x-vmw-nsx-module":"VPNStatistics","type":"object","description":"Session statistics gives aggregated statistics of all policies for all the tunnels.","properties":{"ike_traffic_statistics":{"$ref":"#/definitions/IPSecVPNIKETrafficStatistics"},"display_name":{"readOnly":true,"type":"string","description":"Display name of vpn session.","title":"Display name"},"policy_statistics":{"items":{"$ref":"#/definitions/IPSecVPNPolicyTrafficStatistics"},"readOnly":true,"type":"array","description":"Gives aggregate traffic statistics across all ipsec tunnels and individual tunnel statistics.","title":"IPSec policy statistics"},"partial_stats":{"readOnly":true,"type":"boolean","description":"Partial statistics if true specifies that the statistics are only from active node.","title":"Partial Statistics"},"ipsec_vpn_session_id":{"readOnly":true,"type":"string","description":"UUID of vpn session.","title":"Session identifier"},"last_update_timestamp":{"description":"Timestamp when the data was last updated.","format":"int64","readOnly":true,"type":"integer"},"ike_status":{"$ref":"#/definitions/IPSecVPNIKESessionStatus"},"aggregate_traffic_counters":{"$ref":"#/definitions/IPSecVPNTrafficCounters"}},"title":"IPSec VPN session statistics"},"ProtocolVersion":{"description":"TLS protocol version","title":"TLS protocol version","required":["enabled","name"],"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"enabled":{"type":"boolean","description":"Enable status for this protocol version","title":"Enable status for this protocol version"},"name":{"type":"string","description":"Name of the TLS protocol version","title":"Name of the TLS protocol version"}}},"ReorderMigrationRequest":{"x-vmw-nsx-module":"Migration","required":["id"],"type":"object","properties":{"is_before":{"default":true,"readOnly":false,"type":"boolean","description":"flag indicating whether the migration unit group/migration unit is to be placed before or after the specified migration unit group/migration unit","title":"flag indicating whether the migration unit group/migration unit is to be placed before or after the specified migration unit group/migration unit"},"id":{"readOnly":false,"type":"string","description":"id of the migration unit group/migration unit before/after which the migration unit group/migration unit is to be placed","title":"id of the migration unit group/migration unit before/after which the migration unit group/migration unit is to be placed"}}},"LldpHostSwitchProfile":{"x-vmw-nsx-module":"LldpHostSwitchProfile","allOf":[{"$ref":"#/definitions/BaseHostSwitchProfile"},{"required":["send_enabled"],"x-vmw-nsx-module":"LldpHostSwitchProfile","type":"object","properties":{"send_enabled":{"type":"boolean","description":"Enabled or disabled sending LLDP packets","title":"Enabled or disabled sending LLDP packets"}}}],"description":"Host Switch for LLDP","title":"Host Switch for LLDP"},"ComponentUpgradeChecksInfo":{"description":"Meta-data of pre/post-upgrade checks for a component","title":"Meta-data of pre/post-upgrade checks for a component","required":["component_type"],"x-vmw-nsx-module":"Upgrade","type":"object","properties":{"pre_upgrade_checks_info":{"items":{"$ref":"#/definitions/UpgradeCheckInfo"},"type":"array","description":"Collection of pre-upgrade checks","title":"Collection of pre-upgrade checks"},"post_upgrade_checks_info":{"items":{"$ref":"#/definitions/UpgradeCheckInfo"},"type":"array","description":"Collection of post-upgrade checks","title":"Collection of post-upgrade checks"},"component_type":{"readOnly":false,"type":"string","description":"Component type of the pre/post-upgrade checks","title":"Component type"}}},"NodeAuthProviderVidmStatus":{"description":"Node AAA provider vIDM status","title":"Node AAA provider vIDM status","required":["runtime_state","vidm_enable"],"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"runtime_state":{"type":"string","description":"AAA provider vIDM status","title":"AAA provider vIDM status"},"vidm_enable":{"type":"boolean","description":"vIDM enable flag","title":"vIDM enable flag"}}},"VirtualServiceInstance":{"x-vmw-nsx-module":"ServiceInsertionCommonTypes","allOf":[{"$ref":"#/definitions/BaseServiceInstance"},{"x-vmw-nsx-module":"ServiceInsertionCommonTypes","type":"object"}],"description":"VirtualServiceInstance is a custom instance to be used when NSX is not handling the lifecycles of appliance/s and the user is not bringing their own appliance (BYOD).","title":"Custom Instance of a service"},"DirectoryGroupMemberListResults":{"x-vmw-nsx-module":"DirectoryService","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"DirectoryService","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/DirectoryGroupMember"},"type":"array","description":"Directory group member list","title":"Directory group member list"}}}]},"ServiceInsertionServiceListResult":{"x-vmw-nsx-module":"ServiceInsertion","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"ServiceInsertion","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/ServiceDefinition"},"readOnly":true,"type":"array","description":"List of the Service-Insertion Services. The list has to be homogenous.","title":"Service list"}}}],"description":"Service List","title":"Service List"},"IDSEventsSummary":{"x-vmw-nsx-module":"IDSMetrics","allOf":[{"$ref":"#/definitions/Resource"},{"x-vmw-nsx-module":"IDSMetrics","type":"object","properties":{"first_occurence":{"description":"First occurence of the intrusion, in epoch milliseconds.","format":"int64","readOnly":true,"type":"integer"},"latest_occurence":{"description":"Latest occurence of the intrusion, in epoch milliseconds.","format":"int64","readOnly":true,"type":"integer"},"total_count":{"readOnly":true,"format":"int64","type":"integer","description":"Number of times this particular signature was detected.","title":"Number of occurrences of this signature"},"user_details":{"items":{"$ref":"#/definitions/IdsUserStats"},"readOnly":true,"type":"object","description":"List of users logged into VMs on which a particular signature was detected.","title":"List of users on the affected VMs"},"vm_details":{"items":{"$ref":"#/definitions/IdsVmStats"},"readOnly":true,"type":"object","description":"List of VMs on which a particular signature was detected with the count.","title":"List of VMs this signature was seen"},"is_rule_valid":{"readOnly":true,"type":"boolean","description":"Indicates if the rule id is valid or not.","title":"Is the rule id valid"},"signature_metadata":{"items":{"$ref":"#/definitions/IDSSignatureDetail"},"readOnly":true,"type":"object","description":"Metadata about the detected signature including name, id, severity, product affected, protocol etc.","title":"Metadata about the detected signature"},"idsflow_details":{"items":{"$ref":"#/definitions/IdsEventFlowData"},"readOnly":true,"type":"object","description":"IDS event flow data specific to each IDS event. The data includes source ip, source port, destination ip, destination port, and protocol.","title":"IDS event flow data details"},"signature_id":{"readOnly":true,"format":"int64","type":"integer","description":"Signature ID pertaining to the detected intrusion.","title":"Signature ID"},"rule_id":{"readOnly":true,"format":"int64","type":"integer","description":"The IDS Rule id that detected this particular intrusion.","title":"IDS Rule id of detected intrusion"},"is_ongoing":{"readOnly":true,"type":"boolean","description":"Flag indicating an ongoing intrusion.","title":"Flag indicating an ongoing intrusion"},"affected_vm_count":{"readOnly":true,"format":"int64","type":"integer","description":"Count of VMs on which a particular signature was detected.","title":"Count of VMs this signature was detected on"},"resource_type":{"readOnly":true,"type":"string","description":"IDSEvent resource type.","title":"IDSEvent resource type"}}}],"description":"Intrusion event with all the event and signature details, each event\ncontains the signature id, name, severity, first and recent occurence,\nusers and VMs affected and other signature metadata.\n","title":"Intrusions with event and signature data"},"Datasource":{"description":"An instance of a datasource configuration.","title":"Datasource Instance","required":["display_name","urls"],"x-vmw-nsx-module":"NsxDashboard","type":"object","properties":{"keystore_info":{"$ref":"#/definitions/KeyStoreInfo"},"display_name":{"maxLength":255,"type":"string","description":"Name of a datasource instance.","title":"Datasource instance's display name"},"urls":{"items":{"$ref":"#/definitions/UrlAlias"},"type":"array","description":"Array of urls relative to the datasource configuration. For example, api/v1/fabric/nodes is a relative url of nsx-manager instance.","title":"Array of relative urls and their aliases"}}},"LogicalRouterPortStatisticsPerNode":{"x-vmw-nsx-module":"AggSvcLogicalRouterPort","allOf":[{"$ref":"#/definitions/AggregatedLogicalRouterPortCounters"},{"x-vmw-nsx-module":"AggSvcLogicalRouterPort","type":"object","properties":{"transport_node_id":{"readOnly":true,"type":"string","description":"The ID of the TransportNode","title":"The ID of the TransportNode"}}}]},"NodeSnmpV3EngineID":{"x-vmw-nsx-module":"MISSING_MODULE","allOf":[{"$ref":"#/definitions/NodeServiceProperties"},{"required":["v3_engine_id"],"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"v3_engine_id":{"type":"string","description":"SNMP v3 engine id","title":"SNMP v3 engine id"}}}],"description":"SNMP V3 Engine Id","title":"SNMP V3 Engine Id"},"VtepTableEntry":{"x-vmw-nsx-module":"AggSvcLogicalSwitch","type":"object","properties":{"vtep_label":{"format":"int64","type":"integer","description":"The virtual tunnel endpoint label","title":"The virtual tunnel endpoint label"},"vtep_mac_address":{"type":"string","description":"The virtual tunnel endpoint MAC address","title":"The virtual tunnel endpoint MAC address"},"vtep_ip":{"description":"The virtual tunnel endpoint IP address","format":"ip","type":"string"},"segment_id":{"type":"string","description":"The segment Id","title":"The segment Id"}}},"ServiceConfig":{"x-vmw-nsx-module":"ServiceConfig","allOf":[{"$ref":"#/definitions/ManagedResource"},{"required":["profiles"],"x-vmw-nsx-module":"ServiceConfig","type":"object","properties":{"applied_to":{"items":{"$ref":"#/definitions/ResourceReference"},"type":"array","description":"The list of entities that the configurations should be applied to.\nThis can either be a NSGroup or any other entity like TransportNode, LogicalPorts etc.\n","title":"Entities on which the input profile will be applied"},"precedence":{"description":"Every ServiceConfig has a priority based upon its precedence value. Lower the value\nof precedence, higher will be its priority. If user doesnt specify the precedence,\nit is generated automatically by system. The precedence is generated based upon the\ntype of profile used in ServiceConfig. Precedence are auto-generated in decreasing\norder with difference of 100. Automatically generated precedence value will be 100\nless than the current minimum value of precedence of ServiceConfig of a given profile\ntype in system.There cannot be duplicate precedence for ServiceConfig of same profile\ntype.\n","format":"int64","title":"The priority of the service config","maximum":4294967295,"minimum":0,"type":"integer"},"profiles":{"description":"These are the NSX Profiles which will be added to service config, which\nwill be applied to entities/groups provided to applied_to field of service config.\n","title":"Profiles to be added to service config","minItems":1,"items":{"$ref":"#/definitions/NSXProfileReference"},"maxItems":1,"type":"array"}}}],"description":"Service configs are groupings of profiles (i.e switch profiles) and configurations applied to resources or collection of resources(NSGroups).","title":"Service Config for profile and common configuration"},"IPSecVPNPeerEndpoint":{"x-vmw-nsx-module":"IPSecVPN","allOf":[{"$ref":"#/definitions/ManagedResource"},{"required":["peer_address","peer_id"],"x-vmw-nsx-module":"IPSecVPN","type":"object","properties":{"psk":{"type":"string","description":"IPSec Pre-shared key. Maximum length of this field is 128 characters.","title":"Pre-shared key"},"peer_id":{"type":"string","description":"Peer identifier.","title":"Peer id"},"ipsec_tunnel_profile_id":{"type":"string","description":"Tunnel profile id to be used. By default it will point to system default profile.","title":"IPSec tunnel profile id"},"authentication_mode":{"default":"PSK","enum":["PSK","CERTIFICATE"],"type":"string","description":"Authentication mode used for the peer authentication. For PSK (Pre Shared Key) authentication mode, 'psk' property is mandatory and for the CERTIFICATE authentication mode, 'peer_id' property is mandatory.","title":"Authentication Mode"},"peer_address":{"type":"string","description":"IPV4 address of peer endpoint on remote site.","title":"IPV4 address of peer endpoint on remote site."},"connection_initiation_mode":{"default":"INITIATOR","enum":["INITIATOR","RESPOND_ONLY","ON_DEMAND"],"type":"string","description":"Connection initiation mode used by local\nendpoint to establish ike connection with peer endpoint.\nINITIATOR - In this mode local endpoint initiates tunnel\nsetup and will also respond to incoming tunnel setup requests\nfrom peer gateway.\nRESPOND_ONLY - In this mode, local endpoint shall only\nrespond to incoming tunnel setup requests. It shall not\ninitiate the tunnel setup.\nON_DEMAND - In this mode local endpoint will initiate tunnel\ncreation once first packet matching the policy rule is\nreceived and will also respond to incoming initiation request.\n","title":"Connection initiation mode"},"dpd_profile_id":{"type":"string","description":"Dead peer detection (DPD) profile id. Default will be set according to system default policy.","title":"Dead peer detection (DPD) profile id"},"ike_profile_id":{"type":"string","description":"IKE profile id to be used. Default will be set according to system default policy.","title":"Internet key exchange (IKE) profile id"}}}],"description":"IPSec VPN Peer Endpoint covers configuration to be applied locally to establish a session with remote endpoint on peer site.","title":"IPSec VPN Peer Endpoint"},"IPSecVPNSessionState":{"x-vmw-nsx-module":"IPSecVPN","allOf":[{"$ref":"#/definitions/EdgeConfigurationState"},{"x-vmw-nsx-module":"IPSecVPN","type":"object"}],"description":"This holds the state of IPSec VPN Session. If there are\nerrors in realizing session outside of MP, it gives details\nof the components and specific errors.\n","title":"Realization State of IPSec VPN Session."},"InstanceDeploymentConfig":{"description":"The Instance Deployment Config contains settings that is applied during install time.","title":"Instance Deployment Config","required":["context_id","vm_nic_infos","storage_id","compute_id"],"x-vmw-nsx-module":"ServiceInsertionCommonTypes","type":"object","properties":{"context_id":{"readOnly":false,"type":"string","description":"Context Id or VCenter Id.","title":"Context Id"},"vm_nic_infos":{"description":"List of NIC information for VMs","title":"List of VM NIC information","minItems":1,"items":{"$ref":"#/definitions/VmNicInfo"},"readOnly":false,"maxItems":2,"type":"array"},"storage_id":{"readOnly":false,"type":"string","description":"Storage Id.","title":"storage id"},"host_id":{"readOnly":false,"type":"string","description":"The service VM will be deployed on the specified host in the\nspecified server within the cluster if host_id is specified.\nNote: You must ensure that storage and specified networks are\naccessible by this host.\n","title":"Host id"},"compute_id":{"readOnly":false,"type":"string","description":"Resource Pool or Compute Id.","title":"compute id"}}},"ServiceManager":{"x-vmw-nsx-module":"ServiceInsertionCommonTypes","allOf":[{"$ref":"#/definitions/ManagedResource"},{"required":["port","service_ids","authentication_scheme","uri","server"],"x-vmw-nsx-module":"ServiceInsertionCommonTypes","type":"object","properties":{"port":{"description":"Integer port value to specify a standard/non-standard HTTPS port.","title":"Integer port value to specify a HTTPS port","format":"int64","maximum":65535,"readOnly":false,"minimum":0,"type":"integer"},"service_ids":{"items":{"$ref":"#/definitions/ResourceReference"},"readOnly":false,"type":"array","description":"The IDs of services, provided by partner.","title":"Service IDs"},"authentication_scheme":{"$ref":"#/definitions/CallbackAuthenticationScheme"},"thumbprint":{"type":"string","description":"Thumbprint (SHA-256 hash represented in lower case hex) for the certificate on the partner console. This will be required to establish secure communication with the console and to avoid man-in-the-middle attacks.","title":"Thumbprint of the certificate for partner console"},"vendor_id":{"readOnly":true,"type":"string","description":"Id which is unique to a vendor or partner for which the service is created.","title":"Vendor ID"},"uri":{"readOnly":false,"type":"string","description":"URI on which notification requests should be made on the specified server.","title":"URI notification requests should be made on the server"},"server":{"readOnly":false,"type":"string","description":"IP address or fully qualified domain name of the partner REST server.","title":"IP address or fully qualified domain name of server"}}}],"description":"Partner console endpoint information for enabling NSX to callback with events and status.","title":"Definition of a Service Manager"},"AutomaticHealthCheckListResult":{"x-vmw-nsx-module":"HealthCheck","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"HealthCheck","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/AutomaticHealthCheck"},"readOnly":true,"type":"array","description":"Automatic Health Check List","title":"Automatic Health Check List"}}}],"description":"Automatic health check list result for query with list parameters.","title":"List of Automatic Health Checks"},"ClusterNodeVMDeploymentRequest":{"description":"Contains the deployment information for a cluster node VM soon to be\ndeployed or already deployed by the Manager\n","title":"Info for an auto-deployment request","required":["deployment_config","roles"],"x-vmw-nsx-module":"ClusterNodeVMDeployment","type":"object","properties":{"deployment_config":{"$ref":"#/definitions/ClusterNodeVMDeploymentConfig"},"vm_id":{"readOnly":true,"type":"string","description":"ID of the VM maintained internally and used to recognize it.\nNote: This is automatically generated and cannot be modified.\n","title":"ID of VM used to recognize it"},"user_settings":{"$ref":"#/definitions/NodeUserSettings"},"roles":{"items":{"description":"Enumerates the roles that can be specified in VM auto-deployment.\n","enum":["CONTROLLER","MANAGER"],"type":"string"},"type":"array","description":"List of cluster node role (or roles) which the VM should take on.\nThey specify what type (or types) of cluster node which the new VM\nshould act as.\nCurrently both CONTROLLER and MANAGER must be provided, since this\npermutation is the only one supported now.\n","title":"Cluster node roles of the VM"},"form_factor":{"description":"Specifies the desired \"size\" of the VM\n","default":"MEDIUM","enum":["SMALL","MEDIUM","LARGE"],"type":"string"}}},"UpgradeSummary":{"x-vmw-nsx-module":"Upgrade","type":"object","properties":{"upgrade_coordinator_updated":{"readOnly":true,"type":"boolean","description":"Has upgrade coordinator been updated after upload of upgrade bundle file","title":"Has upgrade coordinator been updated after upload of upgrade bundle file"},"target_version":{"readOnly":true,"type":"string","description":"Target system version","title":"Target system version"},"upgrade_coordinator_version":{"readOnly":true,"type":"string","description":"Current version of upgrade coordinator","title":"Current version of upgrade coordinator"},"upgrade_status":{"readOnly":true,"enum":["SUCCESS","FAILED","IN_PROGRESS","NOT_STARTED","PAUSING","PAUSED"],"type":"string","description":"Status of upgrade","title":"Status of upgrade"},"component_target_versions":{"items":{"$ref":"#/definitions/ComponentTargetVersion"},"readOnly":true,"type":"array"},"system_version":{"readOnly":true,"type":"string","description":"Current system version","title":"Current system version"},"upgrade_bundle_file_name":{"readOnly":true,"type":"string","description":"Name of the last successfully uploaded upgrade bundle file","title":"Name of the last successfully uploaded upgrade bundle file"}}},"MigrationUnit":{"x-vmw-nsx-module":"Migration","allOf":[{"$ref":"#/definitions/Resource"},{"x-vmw-nsx-module":"Migration","type":"object","properties":{"group":{"$ref":"#/definitions/ResourceReference"},"warnings":{"items":{"type":"string"},"readOnly":true,"type":"array","description":"List of warnings indicating issues with the migration unit that may result in migration failure","title":"List of warnings indicating issues with the migration unit that may result in migration failure"},"current_version":{"readOnly":true,"type":"string","description":"This is component version e.g. if migration unit is of type HOST, then this is host version.","title":"Current version of migration unit"},"metadata":{"items":{"$ref":"#/definitions/KeyValuePair"},"readOnly":true,"type":"array","description":"Metadata about migration unit","title":"Metadata about migration unit"},"type":{"readOnly":false,"type":"string","description":"Migration unit type","title":"Migration unit type"},"id":{"readOnly":true,"type":"string","description":"Identifier of the migration unit","title":"UUID of the migration unit"},"display_name":{"readOnly":false,"type":"string","description":"Name of the migration unit","title":"Name of the migration unit"}}}]},"PnicMirrorSource":{"x-vmw-nsx-module":"PortMirroring","allOf":[{"$ref":"#/definitions/MirrorSource"},{"x-vmw-nsx-module":"PortMirroring","required":["node_id","encapsulated","source_pnics"],"type":"object","properties":{"node_id":{"type":"string","description":"Transport node identifier for the pnic located.","title":"Transport node identifier for the pnic located."},"encapsulated":{"default":false,"type":"boolean","description":"Whether to filter encapsulated packet.","title":"Whether to filter encapsulated packet."},"source_pnics":{"minItems":1,"items":{"type":"string"},"type":"array","description":"Source physical NIC device names","title":"Source physical NIC device names"}}}]},"LbSslProfile":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"LoadBalancer","type":"object"}],"description":"Load balancer abstract SSL profile","title":"Load balancer abstract SSL profile"},"ServiceBinding":{"x-vmw-nsx-module":"LogicalRouterPorts","required":["service_id"],"type":"object","properties":{"service_id":{"$ref":"#/definitions/ResourceReference"}}},"TransportInfo":{"x-vmw-nsx-module":"LiveTrace","type":"object","properties":{"src_port":{"description":"Source port","format":"int64","title":"Source port","maximum":65535,"minimum":0,"type":"integer"},"protocol":{"enum":["TCP","UDP","ICMPv4","ICMPv6"],"type":"string","description":"Protocol type over IP layer","title":"Protocol type over IP layer"},"dst_port":{"description":"Destination port","format":"int64","title":"Destination port","maximum":65535,"minimum":0,"type":"integer"}}},"DhcpRelayProfileListResult":{"x-vmw-nsx-module":"DhcpRelay","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"DhcpRelay","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/DhcpRelayProfile"},"type":"array","description":"Dhcp relay profile list results","title":"Dhcp relay profile list results"}}}]},"SiteCompatibilityInfo":{"x-vmw-nsx-module":"SiteManagerModule","type":"object","properties":{"compatibility_list":{"items":{"type":"string"},"type":"array","description":"Compatibility list","title":"Compatibility list"},"site_version":{"type":"string","description":"Site version","title":"Site version"}}},"CPUReservation":{"x-vmw-nsx-module":"FabricNode","type":"object","description":"Relative to the form factor pre-defined reservation value. We recommended\nthat you use the predefined measures of CPU reservation shares to reduce\nthe CPU reservation of a VM. Reservation shares are relative to the\ndefault form-factor value. Though absolute values for CPU reservation\nis supported, we advise to use this option with caution as incorrect or\nhigh reservation values could lead to deployment failure or lead to\nresource starvation for other VMs running on the same host.\n","properties":{"reservation_in_mhz":{"format":"int32","type":"integer","description":"The CPU reservation in MHz is the guaranteed minimum amount of clock\ncycles that the vmkernel CPU scheduler will give the Edge VM in case\nof contention. If an Edge VM is not using its reserved resources, then\nother machines can use them thus preventing waste of CPU cycles on the\nphysical host. Note: We recommend use of reservation_in_shares instead\nof this absolute configuration. When you specify this value, set\nreservation_in_shares to LOW_PRIORITY.\n","title":"CPU reservation in MHz."},"reservation_in_shares":{"default":"HIGH_PRIORITY","enum":["EXTRA_HIGH_PRIORITY","HIGH_PRIORITY","NORMAL_PRIORITY","LOW_PRIORITY"],"type":"string","description":"Shares specify the relative importance of a virtual machine on a given\nhost. When you assign shares to a virtual machine, you always specify\nthe priority for that virtual machine relative to other powered-on\nvirtual machines on the same host. The default priority for shares is\nHIGH_PRIORITY.\n","title":"CPU reservation in shares."}}},"PacketAddressClassifier":{"x-vmw-nsx-module":"Switching","type":"object","description":"A packet is classified to have an address binding, if its address\nconfiguration matches with all user specified properties.\n","properties":{"vlan":{"type":"integer","description":"Virtual Local Area Network Identifier","format":"int64"},"ip_address":{"description":"A single IP address or a subnet, e.g. x.x.x.x or x.x.x.x/y","format":"address-or-block-or-range","type":"string"},"mac_address":{"description":"A single MAC address","format":"mac-address","type":"string"}},"title":"Address classifications for a packet"},"LiveTraceFilterData":{"discriminator":"resource_type","x-vmw-nsx-module":"LiveTrace","required":["resource_type"],"type":"object","properties":{"resource_type":{"enum":["FieldsFilterData","PlainFilterData"],"type":"string","description":"Filter type","title":"Filter type"}}},"BundleUploadStatus":{"x-vmw-nsx-module":"FileUploadFramework","type":"object","description":"Upload status of bundle uploaded from local or remote location.","properties":{"url":{"readOnly":true,"type":"string","description":"URL for uploading bundle.","title":"URL from which the bundle was uploaded"},"bundle_name":{"readOnly":true,"type":"string","description":"Name of the uploaded bundle.","title":"Name of the bundle"},"detailed_status":{"readOnly":true,"type":"string","description":"Detailed status of bundle upload.","title":"Detailed status of bundle upload"},"percent":{"readOnly":true,"type":"number","description":"Percent of bundle uploaded from remote location.","title":"Percent of upload completed"},"status":{"readOnly":true,"enum":["UPLOADING","VERIFYING","SUCCESS","FAILED"],"type":"string","description":"Current status of bundle upload.","title":"Status of bundle upload"}},"title":"Upload status of bundle"},"TunnelPortConfig":{"description":"IP Tunnel port configuration.","title":"IP Tunnel port configuration","required":["ip_subnets"],"x-vmw-nsx-module":"IPSecVPN","type":"object","properties":{"ip_subnets":{"items":{"$ref":"#/definitions/IPSubnet"},"type":"array","description":"IP Tunnel port (commonly referred as VTI) subnet.","maxItems":1,"title":"IP Tunnel port subnet"},"tunnel_port_id":{"readOnly":true,"type":"string","description":"Logical route port identifier.","title":"Logical route port identifier"}}},"CpuUsage":{"x-vmw-nsx-module":"ApplianceStats","type":"object","description":"CPU usage of DPDK and non-DPDK cores","properties":{"avg_cpu_core_usage_dpdk":{"readOnly":true,"type":"number","description":"Indicates the average usage of all DPDK cores in percentage.","title":"Average utilization of all DPDK cores"},"highest_cpu_core_usage_non_dpdk":{"readOnly":true,"type":"number","description":"Indicates the highest cpu utilization value among non_dpdk cores in percentage.","title":"Highest CPU utilization value among non-DPDK cores"},"avg_cpu_core_usage_non_dpdk":{"readOnly":true,"type":"number","description":"Indicates the average usage of all non-DPDK cores in percentage.","title":"Average usage of all non-DPDK cores"},"highest_cpu_core_usage_dpdk":{"readOnly":true,"type":"number","description":"Indicates the highest CPU utilization value among DPDK cores in percentage.","title":"Highest CPU utilization value among DPDK cores"}},"title":"CPU usage of DPDK and non-DPDK cores"},"PolicyTraceflowObservationDelivered":{"x-vmw-nsx-module":"PolicyConnectivity","allOf":[{"$ref":"#/definitions/TraceflowObservationDelivered"},{"x-vmw-nsx-module":"PolicyConnectivity","type":"object","properties":{"segment_port_path":{"readOnly":true,"type":"string","description":"The path of the segment port or router port into which the traceflow packet was delivered","title":"The path of the segment port or router port into which the traceflow packet was delivered"}}}]},"LogicalPortListResult":{"x-vmw-nsx-module":"LogicalPort","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"LogicalPort","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/LogicalPort"},"readOnly":true,"type":"array","description":"LogicalPort Results","title":"LogicalPort Results"}}}],"description":"Logical port queries result","title":"Logical port queries result"},"NatRuleListResult":{"x-vmw-nsx-module":"Nat","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"Nat","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/NatRule"},"type":"array","description":"NAT rule list results","title":"NAT rule list results"}}}]},"ALGTypeNSService":{"x-vmw-nsx-module":"Types","allOf":[{"$ref":"#/definitions/NSServiceElement"},{"required":["alg","destination_ports"],"x-vmw-nsx-module":"Types","type":"object","properties":{"alg":{"enum":["ORACLE_TNS","FTP","SUN_RPC_TCP","SUN_RPC_UDP","MS_RPC_TCP","MS_RPC_UDP","NBNS_BROADCAST","NBDG_BROADCAST","TFTP"],"type":"string","description":"The Application Layer Gateway (ALG) protocol.\nPlease note, protocol NBNS_BROADCAST and NBDG_BROADCAST are deprecated.\nPlease use UDP protocol and create L4 Port Set type of service instead.\n","title":"The Application Layer Gateway (ALG) protocol"},"destination_ports":{"description":"The destination_port cannot be empty and must be a single value.","title":"The destination_port cannot be empty and must be a single value.","minItems":1,"items":{"description":"Examples- Single port \"8080\", Range of ports \"8090-8095\"\n","format":"port-or-range","type":"string"},"maxItems":15,"type":"array"},"source_ports":{"items":{"description":"Examples- Single port \"8080\", Range of ports \"8090-8095\"\n","format":"port-or-range","type":"string"},"type":"array","description":"Source ports","maxItems":15,"title":"Source ports"}}}],"description":"An NSService element that represents an ALG protocol","title":"An NSService element that represents an ALG protocol"},"VtepLabelRange":{"x-vmw-nsx-module":"VtepLabel","allOf":[{"$ref":"#/definitions/Resource"},{"x-vmw-nsx-module":"VtepLabel","required":["start","end"],"type":"object","properties":{"start":{"description":"Start value for virtual tunnel endpoint label range","title":"Virtual tunnel endpoint label range start","format":"int64","maximum":131071,"readOnly":false,"minimum":1,"type":"integer"},"end":{"description":"End value for virtual tunnel endpoint label range","title":"Virtual tunnel endpoint label range end","format":"int64","maximum":131071,"readOnly":false,"minimum":1,"type":"integer"}}}]},"FeedBack":{"description":"Provide details of validation/errors occurred during collection\n,translation and apply phase in MP to Policy promotion.\n","title":"Provide details related to feeback for MP to Policy promotion.\n","required":["mp_display_name","error_list","mp_id","type"],"x-vmw-nsx-module":"MPPolicyMigration","type":"object","properties":{"mp_display_name":{"type":"string","description":"Manager resource display name","title":"Manager resource display name"},"error_list":{"items":{"$ref":"#/definitions/FeedBackErrorMessage"},"type":"array","description":"Error array list","title":"Error array list"},"mp_id":{"type":"string","description":"Manager resource id","title":"Manager resource id"},"type":{"type":"string","description":"Manager resource type","title":"Manager resource type"}}},"EthernetHeader":{"x-vmw-nsx-module":"Traceflow","type":"object","properties":{"dst_mac":{"type":"string","description":"The destination MAC address of form:\n\"^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$\". For example: 00:00:00:00:00:00.\n","title":"Destination MAC address of the Ethernet header"},"eth_type":{"description":"This field defaults to IPv4.","title":"The value of the type field to be put into the Ethernet header","default":2048,"format":"int64","maximum":65535,"minimum":1,"type":"integer"},"src_mac":{"type":"string","description":"The source MAC address of form:\n\"^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$\". For example: 00:00:00:00:00:00.\n","title":"Source MAC address of the Ethernet header"}}},"VmknicNetwork":{"description":"Mapping of all vmk interfaces to destination networks","title":"Vmknic network specification","required":["destination_network","device_name"],"x-vmw-nsx-module":"TransportNode","type":"object","properties":{"destination_network":{"readOnly":false,"type":"string","description":"When migrating vmks to N-VDS/logical switches, the id is the logical switch id. When migrating out of N-VDS/logical switches, the id is the vSphere Switch portgroup name in a single vSphere Standard Switch (VSS), or distributed virtual portgroup name in a single distributed virtual switch (DVS).","title":"The network id to which the ESX vmk interface will be migrated."},"device_name":{"readOnly":false,"type":"string","description":"The vmk interface name, e.g., vmk0, vmk1; the id assigned by vCenter.","title":"ESX vmk interface name"}}},"ActionableResource":{"x-vmw-nsx-module":"ClusterRestore","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"ClusterRestore","type":"object","properties":{"ip_address":{"format":"hostname-or-ip","type":"string","description":"A resource reference on which actions can be performed","title":"A resource reference on which actions can be performed"}}}],"description":"Resources managed during restore process","title":"Resources managed during restore process"},"HealthCheckResult":{"x-vmw-nsx-module":"HealthCheck","type":"object","description":"Result of health check.","properties":{"vlan_mtu_status":{"description":"Overall status of VLAN-MTU health check result.\n","enum":["TRUNKED","UNTRUNKED","UNKNOWN"],"readOnly":true,"type":"string"},"results_per_transport_node":{"items":{"$ref":"#/definitions/HealthCheckResultPerTransportNode"},"readOnly":true,"type":"array","description":"List of health check results on specific transport node.\n","title":"Health Check Results Per Transport Node"},"updated_time":{"description":"Timestamp of check result updated.","format":"int64","readOnly":true,"type":"integer"}},"title":"Health Check Result"},"InterSitePortCounters":{"x-vmw-nsx-module":"AggSvcInterSite","allOf":[{"$ref":"#/definitions/LogicalRouterPortCounters"},{"x-vmw-nsx-module":"AggSvcInterSite","type":"object"}]},"HostSwitchProfileTypeIdEntry":{"x-vmw-nsx-module":"BaseHostSwitchProfile","required":["value"],"type":"object","properties":{"value":{"readOnly":false,"type":"string","description":"key value"},"key":{"description":"Supported HostSwitch profiles.","enum":["UplinkHostSwitchProfile","LldpHostSwitchProfile","NiocProfile","ExtraConfigHostSwitchProfile"],"type":"string"}}},"Dhcpv6Header":{"x-vmw-nsx-module":"Traceflow","type":"object","properties":{"msg_type":{"default":"SOLICIT","enum":["SOLICIT","ADVERTISE","REQUEST","REPLY"],"type":"string","description":"This is used to specify the DHCP v6 message. To request the assignment of one or more IPv6 addresses, a client first locates a DHCP server and then requests the assignment of addresses and other configuration information from the server. The client sends a Solicit message to the All_DHCP_Relay_Agents_and_Servers address to find available DHCP servers. Any server that can meet the client's requirements responds with an Advertise message. The client then chooses one of the servers and sends a Request message to the server asking for confirmed assignment of addresses and other configuration information. The server responds with a Reply message that contains the confirmed addresses and configuration. SOLICIT - A client sends a Solicit message to locate servers. ADVERTISE - A server sends and Advertise message to indicate that it is available. REQUEST - A client sends a Request message to request configuration parameters. REPLY - A server sends a Reply message containing assigned addresses and configuration parameters.","title":"DHCP message type"}}},"BaseNodeAggregateInfo":{"x-vmw-nsx-module":"ClusterManagement","type":"object","properties":{"node_interface_properties":{"items":{"$ref":"#/definitions/NodeInterfaceProperties"},"readOnly":true,"type":"array","description":"Array of Node interface statistic properties","title":"Array of Node interface statistic properties"},"node_status":{"$ref":"#/definitions/ClusterNodeStatus"},"node_interface_statistics":{"items":{"$ref":"#/definitions/NodeInterfaceStatisticsProperties"},"readOnly":true,"type":"array","description":"Array of Node network interface statistic properties","title":"Array of Node network interface statistic properties"},"display_name":{"maxLength":255,"type":"string","description":"Defaults to ID if not set","title":"Identifier to use when displaying entity in logs or GUI"},"node_status_properties":{"items":{"$ref":"#/definitions/NodeStatusProperties"},"type":"array","description":"Time series of the node's system properties","title":"Time series of the node's system properties"},"id":{"readOnly":true,"type":"string","description":"Unique identifier of this resource","title":"Unique identifier of this resource"}}},"GridConfiguration":{"x-vmw-nsx-module":"NsxDashboard","allOf":[{"$ref":"#/definitions/WidgetConfiguration"},{"required":["row_list_fields","columns"],"x-vmw-nsx-module":"NsxDashboard","type":"object","properties":{"page_size":{"default":30,"format":"int32","type":"integer","description":"Number of records per page. page_size will be effective only when the urls provided in the datasource support paging.","title":"Page Size"},"row_list_fields":{"minItems":1,"items":{"$ref":"#/definitions/RowListField"},"type":"array","description":"Rows of grid or table are formed from the list of objects returned by a row list field.","title":"List of fields from which rows are formed"},"columns":{"items":{"$ref":"#/definitions/ColumnItem"},"type":"array","description":"Array of columns of a Grid widget","title":"Columns"}}}],"description":"Represents configuration of a Grid or Table widget.","title":"Grid Configuration"},"IPSecVPNIKEProfileListResult":{"x-vmw-nsx-module":"IPSecVPN","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"IPSecVPN","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/IPSecVPNIKEProfile"},"type":"array","description":"IKE Profile list results","title":"IKE Profile list results"}}}],"description":"List all the IKE profiles.","title":"List IKE profiles"},"LiveTraceListResult":{"x-vmw-nsx-module":"LiveTrace","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"LiveTrace","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/LiveTraceStatus"},"type":"array","description":"Livetrace status list","title":"Livetrace status list"}}}]},"ContainerNetworkPolicy":{"x-vmw-nsx-module":"InventoryContainerObj","allOf":[{"$ref":"#/definitions/DiscoveredResource"},{"required":["external_id"],"x-vmw-nsx-module":"InventoryContainerObj","type":"object","properties":{"network_status":{"readOnly":false,"enum":["HEALTHY","UNHEALTHY"],"type":"string","description":"Network status of container network policy.","title":"Network status of container network policy"},"container_cluster_id":{"readOnly":false,"type":"string","description":"Identifier of the container cluster this network policy belongs to.","title":"Identifier of the container cluster"},"policy_type":{"readOnly":false,"enum":["NETWORK_POLICY","ASG","ACNP","ANP"],"type":"string","description":"Type e.g. Network Policy, ASG.","title":"Type"},"origin_properties":{"items":{"$ref":"#/definitions/KeyValuePair"},"readOnly":false,"type":"array","description":"Array of additional specific properties of container network policy\nin key-value format.\n","title":"Origin properties"},"external_id":{"readOnly":false,"type":"string","description":"Identifier of the container network policy.","title":"External identifier of the container network policy"},"container_project_id":{"readOnly":false,"type":"string","description":"Identifier of the project which this network policy belongs to.","title":"Identifier of the project"},"network_errors":{"items":{"$ref":"#/definitions/NetworkError"},"readOnly":false,"type":"array","description":"List of network errors related to container network policy.","title":"Network errors"},"spec":{"readOnly":false,"type":"string","description":"Container network policy specification.","title":"Container network policy specification"}}}],"description":"Network policy applied to container.","title":"Container Network Policy"},"VtepLabelPoolListResult":{"x-vmw-nsx-module":"VtepLabel","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"VtepLabel","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/VtepLabelPool"},"type":"array","description":"Virtual tunnel endpoint label pool list results","title":"Virtual tunnel endpoint label pool list results"}}}]},"NodeNetworkInterfacePropertiesListResult":{"x-vmw-nsx-module":"MISSING_MODULE","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/NodeNetworkInterfaceProperties"},"type":"array","description":"Node network interface property results","title":"Node network interface property results"}}}],"description":"Node network interface properties list results","title":"Node network interface properties list results"},"SupportBundleRemoteFileServer":{"description":"Remote file server","title":"Remote file server","required":["directory_path","protocol","server"],"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"manager_upload_only":{"default":false,"type":"boolean","description":"Uploads to the remote file server performed by the manager","title":"Uploads to the remote file server performed by the manager"},"directory_path":{"type":"string","description":"Remote server directory to copy bundle files to","title":"Remote server directory to copy bundle files to"},"protocol":{"$ref":"#/definitions/SupportBundleFileTransferProtocol"},"port":{"description":"Server port","title":"Server port","default":22,"format":"int64","maximum":65535,"minimum":1,"type":"integer"},"server":{"type":"string","description":"Remote server hostname or IP address","title":"Remote server hostname or IP address"}}},"CsvRecord":{"x-vmw-nsx-module":"CsvTypes","type":"object","description":"Base type for CSV records."},"ThreatStatus":{"x-vmw-nsx-module":"Heatmap","type":"object","properties":{"status":{"enum":["NORMAL","ABNORMAL"],"type":"string","description":"Transport node threat status","title":"Transport node threat status"}}},"VirtualMachineListResult":{"x-vmw-nsx-module":"Inventory","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"Inventory","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/VirtualMachine"},"type":"array","description":"VirtualMachine list results","title":"VirtualMachine list results"}}}]},"PropertyItem":{"description":"Represents a label-value pair.","title":"LabelValue Property","required":["field","type"],"x-vmw-nsx-module":"NsxDashboard","type":"object","properties":{"style":{"type":"object","description":"A style object applicable for the property item. It could be the any padding, margin style sheet applicable to the property item. A 'style' property is supported in case of layout 'AUTO' only.","title":"A Style object applicable for the Property Item"},"rowspan":{"format":"int32","minimum":1,"type":"integer","description":"Represent the vertical span of the widget / container","title":"Vertical span"},"span":{"description":"Represent the horizontal span of the widget / container.","format":"int32","title":"Horizontal span","maximum":12,"minimum":1,"type":"integer"},"label_value_separator":{"type":"string","description":"Label value separator used between label and value. It can be any separator like \":\" or \"-\".","title":"Labale value separator used between label and value"},"label":{"$ref":"#/definitions/Label"},"field":{"maxLength":1024,"type":"string","description":"Represents field value of the property.","title":"Field of the Property"},"separator":{"default":false,"type":"boolean","description":"If true, separates this property in a widget.","title":"A separator after this property"},"type":{"description":"Data type of the field.","title":"field data type","default":"String","enum":["String","Number","Date","Url"],"maxLength":255,"type":"string"},"drilldown_id":{"type":"string","description":"Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget.","title":"Id of drilldown widget"},"navigation":{"maxLength":1024,"type":"string","description":"Hyperlink of the specified UI page that provides details. This will be linked with value of the property.","title":"Navigation to a specified UI page"},"heading":{"default":false,"type":"boolean","description":"Set to true if the field is a heading. Default is false.","title":"If true, represents the field as a heading"},"condition":{"maxLength":1024,"type":"string","description":"If the condition is met then the property will be displayed. Examples of expression syntax are provided under 'example_request' section of 'CreateWidgetConfiguration' API.","title":"Expression for evaluating condition"},"render_configuration":{"items":{"$ref":"#/definitions/RenderConfiguration"},"type":"array","description":"Render configuration to be applied, if any.","title":"Render Configuration"}}},"NSServiceListResult":{"x-vmw-nsx-module":"NSService","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"NSService","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/NSService"},"type":"array","description":"Paged collection of NSServices","title":"Paged collection of NSServices"}}}],"description":"List result of NSservices","title":"List result of NSservices"},"AcceptableComponentVersionList":{"x-vmw-nsx-module":"VersionWhitelist","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/AcceptableComponentVersion"},"type":"array","description":"Acceptable version whitelist for different components","title":"Acceptable version whitelist for different components"}}},"LbHttpRequestHeader":{"x-vmw-nsx-module":"LoadBalancer","required":["header_value","header_name"],"type":"object","properties":{"header_value":{"type":"string","description":"Value of HTTP request header","title":"Value of HTTP request header"},"header_name":{"type":"string","description":"Name of HTTP request header","title":"Name of HTTP request header"}}},"ServiceInsertionService":{"x-vmw-nsx-module":"ServiceInsertionRules","allOf":[{"$ref":"#/definitions/DSService"},{"x-vmw-nsx-module":"ServiceInsertionRules","type":"object"}],"description":"Protocol on which a particular ServiceInsertion Rule should apply to.","title":"ServiceInsertion Service"},"FooterAction":{"description":"Action specified at the footer of a widget to provide additional information or to provide a clickable url for navigation. An example usage of footer action is provided under the 'example_request' section of 'CreateWidgetConfiguration' API.","title":"Widget Footer Action","required":["label"],"x-vmw-nsx-module":"NsxDashboard","type":"object","properties":{"url":{"maxLength":1024,"type":"string","description":"Hyperlink to the UI page that provides details of action.","title":"Clickable hyperlink, if any"},"dock_to_container_footer":{"default":true,"type":"boolean","description":"If true, the footer will appear in the underlying container that holds the widget.","title":"Dock the footer at container"},"label":{"$ref":"#/definitions/Label"}}},"IpBlockSubnet":{"x-vmw-nsx-module":"Ipam","description":"A set of IPv4/IPv6 addresses defined by a start address and a mask/prefix which will typically be associated with a layer-2 broadcast domain.","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"Ipam","required":["block_id","size"],"type":"object","properties":{"start_ip":{"description":"For internal system use Only. Represents start ip address of the subnet from IP block. Subnet ip adddress will start from this ip address.","format":"ip","type":"string"},"cidr":{"readOnly":true,"format":"ip-cidr-block","type":"string","description":"Represents network address and the prefix length which will be associated with a layer-2 broadcast domain","title":"Represents network address and the prefix length which will be associated with a layer-2 broadcast domain"},"allocation_ranges":{"items":{"$ref":"#/definitions/IpPoolRange"},"readOnly":true,"type":"array","description":"A collection of IPv4/IPv6 IP ranges used for IP allocation.","title":"A collection of IPv4/IPv6 IP ranges used for IP allocation."},"block_id":{"readOnly":false,"type":"string","description":"Block id for which the subnet is created.","title":"Block id for which the subnet is created."},"size":{"format":"int64","type":"integer","description":"Represents the size or number of ip addresses in the subnet","title":"Represents the size or number of ip addresses in the subnet"}}}]},"KeyValuePair":{"description":"An arbitrary key-value pair","title":"An arbitrary key-value pair","required":["value","key"],"x-vmw-nsx-module":"Common","type":"object","properties":{"value":{"readOnly":false,"maxLength":255,"type":"string","description":"Value","title":"Value"},"key":{"readOnly":false,"maxLength":255,"type":"string","description":"Key","title":"Key"}}},"TransportZoneProfileListResult":{"x-vmw-nsx-module":"TransportZoneProfile","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"TransportZoneProfile","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/TransportZoneProfile"},"readOnly":true,"type":"array","description":"Transport zone profile results","title":"Transport zone profile results"}}}],"description":"Transport zone profile queries result","title":"Transport zone profile queries result"},"SoftwareModuleResult":{"description":"Software module result","title":"Software module result","required":["software_modules"],"x-vmw-nsx-module":"FabricNode","type":"object","properties":{"software_modules":{"items":{"$ref":"#/definitions/SoftwareModule"},"type":"array","description":"Software module results","title":"Software module results"}}},"BgpNeighborStatus":{"x-vmw-nsx-module":"AggSvcLogicalRouter","type":"object","properties":{"connection_state":{"readOnly":true,"enum":["INVALID","IDLE","CONNECT","ACTIVE","OPEN_SENT","OPEN_CONFIRM","ESTABLISHED","UNKNOWN"],"type":"string","description":"Current state of the BGP session.","title":"Current state of the BGP session."},"messages_received":{"readOnly":true,"format":"int64","type":"integer","description":"Count of messages received from the neighbor","title":"Count of messages received from the neighbor"},"keep_alive_interval":{"readOnly":true,"format":"int64","type":"integer","description":"Time in ms to wait for HELLO packet from BGP peer","title":"Time in ms to wait for HELLO packet from BGP peer"},"neighbor_router_id":{"description":"Router ID of the BGP neighbor.","format":"ip","readOnly":true,"type":"string"},"total_out_prefix_count":{"readOnly":true,"format":"int64","type":"integer","description":"Sum of out prefixes counts across all address families.","title":"Count of out prefixes"},"lr_component_id":{"readOnly":true,"type":"string","description":"Logical router component(Service Router/Distributed Router) id","title":"Logical router component(Service Router/Distributed Router) id"},"established_connection_count":{"readOnly":true,"format":"int64","type":"integer","description":"Count of connections established","title":"Count of connections established"},"messages_sent":{"readOnly":true,"format":"int64","type":"integer","description":"Count of messages sent to the neighbor","title":"Count of messages sent to the neighbor"},"time_since_established":{"readOnly":true,"format":"int64","type":"integer","description":"Time(in seconds) since connection was established.","title":"Time(in seconds) since connection was established."},"hold_time":{"readOnly":true,"format":"int64","type":"integer","description":"Time in ms to wait for HELLO from BGP peer. If a HELLO packet is not seen from BGP Peer withing hold_time then BGP neighbor will be marked as down.","title":"Time in ms to wait for HELLO from BGP peer. If a HELLO packet is not seen from BGP Peer withing hold_time then BGP neighbor will be marked as down."},"graceful_restart":{"readOnly":true,"type":"boolean","description":"Current state of graceful restart where\ngraceful_restart = true indicates graceful restart is enabled and\ngraceful_restart = false indicates graceful restart is disabled.\nThis is deprecated field, use graceful_restart_mode instead.\n","x-deprecated":true,"title":"Graceful restart flag"},"graceful_restart_mode":{"readOnly":true,"type":"string","description":"Current state of graceful restart of BGP neighbor. Possible\nvalues are -\n1. GR_AND_HELPER - Graceful restart with Helper\n2. HELPER_ONLY - Helper only\n3. DISABLE - Disabled\n","title":"Graceful restart mode"},"connection_drop_count":{"readOnly":true,"format":"int64","type":"integer","description":"Count of connection drop","title":"Count of connection drop"},"remote_port":{"description":"TCP port number of remote BGP Connection","title":"TCP port number of remote BGP Connection","format":"int64","maximum":65535,"readOnly":true,"minimum":1,"type":"integer"},"source_address":{"description":"The Ip address of logical port","format":"ip","readOnly":true,"type":"string"},"total_in_prefix_count":{"readOnly":true,"format":"int64","type":"integer","description":"Sum of in prefixes counts across all address families.","title":"Count of in prefixes"},"remote_site":{"$ref":"#/definitions/ResourceReference"},"transport_node":{"$ref":"#/definitions/ResourceReference"},"local_port":{"description":"TCP port number of Local BGP connection","title":"TCP port number of Local BGP connection","format":"int64","maximum":65535,"readOnly":true,"minimum":1,"type":"integer"},"remote_as_number":{"readOnly":true,"type":"string","description":"AS number of the BGP neighbor","title":"AS number of the BGP neighbor"},"announced_capabilities":{"items":{"type":"string"},"readOnly":true,"type":"array","description":"BGP capabilities sent to BGP neighbor.","title":"BGP capabilities sent to BGP neighbor."},"negotiated_capability":{"items":{"type":"string"},"readOnly":true,"type":"array","description":"BGP capabilities negotiated with BGP neighbor.","title":"BGP capabilities negotiated with BGP neighbor."},"address_families":{"items":{"$ref":"#/definitions/BgpAddressFamily"},"readOnly":true,"type":"array","description":"Address families of BGP neighbor","title":"Address families of BGP neighbor"},"type":{"readOnly":true,"enum":["INTER_SR","USER"],"type":"string","description":"BGP neighbor type","title":"BGP neighbor type"},"neighbor_address":{"description":"The IP of the BGP neighbor","format":"ip","readOnly":true,"type":"string"}}},"GenericDhcpOption":{"description":"Define DHCP options other than option 121.","title":"Generic DHCP option","required":["code","values"],"x-vmw-nsx-module":"Dhcp","type":"object","properties":{"code":{"description":"Code of the dhcp option.","format":"int64","title":"DHCP option code, [0-255]","maximum":255,"minimum":0,"type":"integer"},"values":{"description":"Value of the option.","title":"DHCP option value","minItems":1,"items":{"type":"string"},"maxItems":10,"type":"array"}}},"NSServiceGroup":{"x-vmw-nsx-module":"NSServiceGroup","description":"A Networking and Security Service Group that represents a group of NSServices\n","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"NSServiceGroup","required":["members"],"type":"object","properties":{"default_service":{"readOnly":true,"type":"boolean","description":"The default NSServiceGroups are created in the system by default. These\nNSServiceGroups can't be modified/deleted\n","title":"NSServiceGroups created in the system by default"},"service_type":{"readOnly":true,"enum":["ETHER","NON_ETHER"],"type":"string","description":"Type of the NSServiceGroup","title":"Type of the NSServiceGroup"},"members":{"items":{"$ref":"#/definitions/ResourceReference"},"type":"array","description":"List of NSService resources that can be added as members\nto an NSServiceGroup.\n","maxItems":50}}}]},"NSGroupComplexExpression":{"x-vmw-nsx-module":"NSGroup","allOf":[{"$ref":"#/definitions/NSGroupExpression"},{"required":["expressions"],"x-vmw-nsx-module":"NSGroup","type":"object","properties":{"expressions":{"description":"Represents expressions which are to be logically 'AND'ed.The array cannot contain\nNSGroupComplexExpression.Only NSGroupTagExpression and NSGroupSimpleExpressions\nare accepted.\n","title":"List of simple and tag expressions","minItems":2,"items":{"$ref":"#/definitions/NSGroupExpression"},"maxItems":5,"type":"array"}}}],"description":"Complex expressions to represent NSGroup membership","title":"Complex expressions to represent NSGroup membership"},"MigrationUnitAggregateInfo":{"x-vmw-nsx-module":"Migration","allOf":[{"$ref":"#/definitions/Resource"},{"x-vmw-nsx-module":"Migration","type":"object","properties":{"status":{"readOnly":true,"enum":["SUCCESS","FAILED","IN_PROGRESS","NOT_STARTED","PAUSING","PAUSED"],"type":"string","description":"Status of migration unit","title":"Status of migration unit"},"percent_complete":{"readOnly":true,"type":"number","description":"Indicator of migration progress in percentage","title":"Indicator of migration progress in percentage"},"errors":{"items":{"type":"string"},"readOnly":true,"type":"array","description":"List of errors occurred during migration of this migration unit","title":"List of errors occurred during migration of this migration unit"},"unit":{"$ref":"#/definitions/MigrationUnit"}}}]},"NodeSnmpServiceProperties":{"x-vmw-nsx-module":"MISSING_MODULE","allOf":[{"$ref":"#/definitions/NodeServiceProperties"},{"required":["service_properties"],"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"service_properties":{"$ref":"#/definitions/SnmpServiceProperties"}}}],"description":"Node SNMP service properties","title":"Node SNMP service properties"},"ManagementPlaneProperties":{"x-vmw-nsx-module":"MISSING_MODULE","allOf":[{"$ref":"#/definitions/Resource"},{"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"account":{"readOnly":false,"description":"The account name to use when authenticating to the management plane's message bus."},"secret":{"type":"string","description":"The shared secret to use when autnenticating to the management plane's message bus. Not returned in REST responses."},"brokers":{"items":{"$ref":"#/definitions/ManagementPlaneBrokerProperties"},"type":"array","description":"The list of messaging brokers this controller is configured with."}}}],"description":"Information about the management plane this controller is communciating with","title":"Information about the management plane this controller is communciating with"},"BridgeEndpoint":{"x-vmw-nsx-module":"BridgeEndpoint","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"BridgeEndpoint","type":"object","properties":{"ha_enable":{"default":true,"type":"boolean","description":"This field will not be used if an edge cluster is being used for the\nbridge endpoint\n","title":"Controls the enabling of HA on the VLAN for this endpoint"},"bridge_cluster_id":{"maxLength":36,"type":"string","description":"This field will not be used if an edge cluster is being used for the\nbridge endpoint\n","title":"UUID of the bridge cluster for this bridge endpoint"},"vlan_transport_zone_id":{"type":"string","description":"This field will not be used if a bridge cluster is being used for the\nbridge endpoint\n","title":"VLAN transport zone id by the edge cluster"},"bridge_endpoint_profile_id":{"type":"string","description":"This field will not be used if a bridge cluster is being used for the\nbridge endpoint\n","title":"Bridge endpoint profile used by the edge cluster"},"uplink_teaming_policy_name":{"type":"string","description":"This name has to be one of the switching uplink teaming policy names listed inside the TransportZone. If this field is not specified, bridge will use the first pnic in host-switch config. This field will not be used if a bridge cluster is being used for the bridge endpoint","title":"The name of the switching uplink teaming policy for the bridge endpoint"},"vlan_trunk_spec":{"$ref":"#/definitions/VlanTrunkSpec"},"vlan":{"type":"integer","description":"This property is used for VLAN specification of bridge endpoint.\nIt's mutually exclusive with 'vlan_trunk_spec', either 'vlan' or 'vlan_trunk_spec'\nshould be specified.\n","format":"int64"}}}],"description":"A bridge endpoint can be created on a bridge cluster or on an edge\ncluster. Few of the properties of this class will not be used depending on\nthe type of bridge endpoint being created. When creating a bridge endpoint\non a bridge cluster, following propeties will be used: vlan,\nbridge_cluster_id and ha_enable. Similarly, for creating a bridge endpoint\non an edge cluster following properties will be used: vlan,\nbridge_endpoint_profile_id and vlan_transport_zone_id.\n","title":"Bridge Endpoint"},"BGPCommunityList":{"x-vmw-nsx-module":"Routing","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"Routing","required":["communities"],"type":"object","properties":{"communities":{"items":{"type":"string"},"type":"array","description":"Array of BGP communities","title":"BGP community list"},"logical_router_id":{"readOnly":true,"type":"string","description":"Logical router id","title":"Logical router id"},"community_type":{"default":"NormalBGPCommunity","enum":["NormalBGPCommunity","LargeBGPCommunity"],"type":"string","description":"BGP community type. It has two types as\nNormalBGPCommunity BGP normal community which includes well-known\ncommunity name as well as community value in range from [1-4294967295]\nor value in aa:nn format(aa/nn range from 1-65535).\nLargeBGPCommunity BGP large community which includes community value\nin aa:bb:nn format where aa, bb, nn are unsigned integers in the range\n[1-4294967295].\n","title":"BGP community type"}}}]},"MPPolicyPromotionHistory":{"description":"Contain mp to policy promotion history.\n","title":"Contain mp to policy promotion history.\n","required":["status"],"x-vmw-nsx-module":"PolicyMigration","type":"object","properties":{"status":{"enum":["INITIATED","CANCELLED","SUCCESS","PARTIAL_SUCCESS"],"type":"string","description":"Represents the type of operation in the mp to policy promotion life cycle. Can be INITIATED, CANCELLED, PARTIAL_SUCCESS or SUCCESS.\n","title":"Represents the type of operation in the mp to policy promotion life cycle.\n"},"date_time":{"readOnly":true,"type":"string","description":"Date and and time of the promotion operation. The date and time is stored in epoch time format.\n","title":"Date and and time of the promotion operation."}}},"UpgradeUnitGroupAggregateInfo":{"x-vmw-nsx-module":"Upgrade","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"Upgrade","required":["type"],"type":"object","properties":{"status":{"readOnly":true,"enum":["SUCCESS","FAILED","IN_PROGRESS","NOT_STARTED","PAUSING","PAUSED"],"type":"string","description":"Upgrade status of upgrade unit group","title":"Upgrade status of upgrade unit group"},"upgrade_unit_count":{"readOnly":true,"format":"int32","type":"integer","description":"Number of upgrade units in the group","title":"Count of upgrade units in the group"},"failed_count":{"readOnly":true,"format":"int32","type":"integer","description":"Number of nodes in the upgrade unit group that failed upgrade","title":"Number of nodes in the upgrade unit group that failed upgrade"},"post_upgrade_status":{"$ref":"#/definitions/UpgradeChecksExecutionStatus"},"enabled":{"default":true,"readOnly":false,"type":"boolean","description":"Flag to indicate whether upgrade of this group is enabled or not","title":"Flag to indicate whether upgrade of this group is enabled or not"},"upgrade_units":{"description":"List of upgrade units in the group","title":"List of upgrade units in the group","items":{"$ref":"#/definitions/UpgradeUnit"},"readOnly":false,"maxItems":100,"type":"array"},"extended_configuration":{"description":"Extended configuration for the group","title":"Extended configuration for the group","items":{"$ref":"#/definitions/KeyValuePair"},"readOnly":false,"maxItems":100,"type":"array"},"percent_complete":{"readOnly":true,"type":"number","description":"Indicator of upgrade progress in percentage","title":"Indicator of upgrade progress in percentage"},"type":{"readOnly":false,"type":"string","description":"Component type","title":"Component type"},"parallel":{"default":true,"readOnly":false,"type":"boolean","description":"Upgrade method to specify whether the upgrade is to be performed in parallel or serially","title":"Upgrade method to specify whether the upgrade is to be performed in parallel or serially"},"group_level_failure":{"items":{"type":"string"},"readOnly":true,"type":"array","description":"Reports failures that occured at the group or cluster level.","title":"Reports failures that occured at the group or cluster level."}}}]},"ServicePathListResult":{"x-vmw-nsx-module":"ServiceInsertion","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"ServiceInsertion","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/ServicePath"},"readOnly":true,"type":"array","description":"List of homogenous service paths","title":"Service Path list"}}}],"description":"Service path list","title":"Service path list"},"TimeRangeFilterInfo":{"x-vmw-nsx-module":"NsxDashboard","type":"object","description":"time range filter information","properties":{"to_param_name":{"default":"toDate","maxLength":1024,"type":"string","description":"to parameter name used for time range filter to date value.","title":"to parameter name for time range filter"},"from_param_name":{"default":"fromDate","maxLength":1024,"type":"string","description":"from parameter name used for time range filter from date value.","title":"from parameter name for time range filter."},"value_type":{"default":"EPOCH","enum":["EPOCH"],"type":"string","description":"type of time range filter value can be epoch, ISO date Format.","title":"type of time range filter value"}},"title":"time range filter information"},"DailyTelemetrySchedule":{"x-vmw-nsx-module":"TelemetryConfig","allOf":[{"$ref":"#/definitions/TelemetrySchedule"},{"x-vmw-nsx-module":"TelemetryConfig","required":["hour_of_day"],"type":"object","properties":{"minutes":{"description":"Minute at which data will be collected. Specify a value between 0 through 59.\n","title":"Minute at which data will be collected","default":0,"format":"int64","maximum":59,"minimum":0,"type":"integer"},"hour_of_day":{"description":"Hour at which data will be collected. Specify a value between 0 through 23.\n","format":"int64","title":"Hour at which data will be collected","maximum":23,"minimum":0,"type":"integer"}}}]},"IPSecVPNSessionListResult":{"x-vmw-nsx-module":"IPSecVPN","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"IPSecVPN","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/IPSecVPNSession"},"type":"array","description":"IPSec VPN sessions list result","title":"IPSec VPN sessions list result"}}}],"description":"List all the IPSec VPN sessions.","title":"List IPSec VPN sessions"},"DADProfileListResult":{"x-vmw-nsx-module":"Routing","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"Routing","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/DADProfile"},"type":"array","description":"Paginated list of DADProfile","title":"Paginated list of DADProfile"}}}]},"IPAddresses":{"x-vmw-nsx-module":"PortMirroring","type":"object","properties":{"ip_addresses":{"minItems":1,"items":{"description":"IPElement can be a single IP address, IP address range or a Subnet. Its\ntype can be of IPv4 or IPv6. Supported list of formats are \"192.168.1.1\",\n\"192.168.1.1-192.168.1.100\", \"192.168.0.0/24\",\n\"fe80::250:56ff:fe83:318c\",\n\"fe80::250:56ff:fe83:3181-fe80::250:56ff:fe83:318c\",\n\"fe80::250:56ff:fe83:318c/64\"\n","format":"address-or-block-or-range","type":"string"},"type":"array","description":"The IP addresses in the form of IP Address, IP Range, CIDR, used as source IPs or destination IPs of filters.","title":"IPs of the filter"}}},"IntelligenceBrokerEndpointInfo":{"description":"This is deprecated. Please use CommonAgentEndpointInfo instead.\nAn endpoint to connect to NSX-Intelligence broker.\nEither FQDN or IP address can be used in the endpoint info.\n","title":"NSX-Intelligence broker endpoint","required":["port","address"],"x-vmw-nsx-module":"NsxIntelligenceHostConfiguration","type":"object","properties":{"port":{"description":"The port number where the broker is listening to.\n","format":"int64","title":"Broker port number","maximum":65535,"minimum":1,"type":"integer"},"address":{"format":"hostname-or-ip","type":"string","description":"The IP address or the full qualified domain name of broker.\n","title":"Broker address"}}},"EdgeClusterMemberStatus":{"x-vmw-nsx-module":"AggSvcEdgeCluster","required":["transport_node","status"],"type":"object","properties":{"transport_node":{"$ref":"#/definitions/ResourceReference"},"status":{"enum":["UP","DOWN","ADMIN_DOWN","PARTIALLY_DISCONNECTED","UNKNOWN"],"type":"string","description":"Status of an edge node","title":"Status of an edge node"}}},"MultiWidgetConfiguration":{"x-vmw-nsx-module":"NsxDashboard","allOf":[{"$ref":"#/definitions/WidgetConfiguration"},{"required":["widgets"],"x-vmw-nsx-module":"NsxDashboard","type":"object","properties":{"widgets":{"description":"Array of widgets that are part of the multi-widget.","title":"Widgets","minItems":1,"items":{"$ref":"#/definitions/WidgetItem"},"maxItems":2,"type":"array"},"navigation":{"maxLength":1024,"type":"string","description":"Hyperlink of the specified UI page that provides details.","title":"Navigation to a specified UI page"}}}],"description":"Combines two or more widgetconfigurations into a multi-widget","title":"Multi-Widget"},"BatchResponseItem":{"description":"A single respose in a list of batched responses","title":"A single respose in a list of batched responses","required":["code"],"x-vmw-nsx-module":"Common","type":"object","properties":{"body":{"type":"object","description":"object returned by api","title":"object returned by api"},"headers":{"type":"object","description":"The headers returned by the API call","title":"object returned by api"},"code":{"format":"int64","type":"integer","description":"http status code","title":"object returned by api"}}},"MigrationFeedbackRequest":{"x-vmw-nsx-module":"Migration","type":"object","description":"Detailed feedback requests from the migration tool where user input is required.","properties":{"resolved":{"readOnly":true,"type":"boolean","description":"Indicates if a valid response already exist for this feedback request.","title":"Indicates if this feedback request has already been resolved"},"v_object_name":{"readOnly":true,"type":"string","description":"Name of this object in the source NSX endpoint.","title":"Name of this object in the source NSX endpoint"},"hash":{"readOnly":true,"type":"string","description":"Identify a feedback request type across objects. This can be used to group together objects with similar feedback request and resolve them in one go.","title":"Identifier for a feedback request type"},"accepted_actions":{"items":{"type":"string"},"readOnly":true,"type":"array","description":"List of acceptable actions for this feedback request.","title":"Acceptable actions for this feedback request"},"vertical":{"readOnly":true,"type":"string","description":"Functional area that this query falls into.","title":"Functional area for the feedback query"},"v_object_id":{"readOnly":true,"type":"string","description":"Identifier for this object in the source NSX endpoint.","title":"Id of this object in the source NSX endpoint"},"suggested_value":{"readOnly":true,"type":"string","description":"The suggested value to resolve this feedback request.","title":"Suggested value for this feedback request"},"message":{"readOnly":true,"type":"string","description":"Detailed feedback request with options.","title":"Content of feedback request"},"multi_value":{"readOnly":true,"type":"boolean","description":"Indicates if multiple values can be selected as response from the list of acceptable value.","title":"Indicates if multiple values can be selected as response"},"accepted_value_type":{"readOnly":true,"type":"string","description":"Data type of the items listed in acceptable values list.","title":"Data type of the items listed in acceptable values"},"federation_site_id":{"readOnly":true,"type":"string","description":"Id of the site in NSX-T Federation","title":"Id of the site in NSX-T Federation"},"object_id":{"readOnly":true,"type":"string","description":"Identifier of the object for which feedback is requested.","title":"UUID of the object"},"accepted_values":{"items":{"type":"string"},"type":"array","description":"List of acceptable values for this feedback request.","title":"Acceptable values for this feedback request"},"id":{"readOnly":true,"type":"string","description":"Identifier of the feedback request.","title":"UUID of the feedback request"},"suggested_action":{"readOnly":true,"type":"string","description":"The suggested action to resolve this feedback request.","title":"Suggested action for this feedback request"},"sub_vertical":{"readOnly":true,"type":"string","description":"Functional sub-area that this query falls into.","title":"Functional sub-area for the feedback query"},"resolution":{"readOnly":true,"type":"string","description":"If the feedback request was resolved earlier, provides details about the previous resolution.","title":"Previous resolution details for this feedback request"},"rejected":{"readOnly":true,"type":"boolean","description":"Indicates if previous response was invalid. Please provide a valid response.","title":"Indicates if the previous feedback response was rejected"}},"title":"Feedback detail required for Migration"},"ManagementNodeAggregateInfo":{"x-vmw-nsx-module":"ClusterManagement","allOf":[{"$ref":"#/definitions/BaseNodeAggregateInfo"},{"x-vmw-nsx-module":"ClusterManagement","type":"object","properties":{"transport_nodes_connected":{"readOnly":true,"minimum":0,"type":"integer","format":"int64"},"role_config":{"$ref":"#/definitions/ManagementClusterRoleConfig"}}}]},"ClusterNodeVMDeploymentStatusReport":{"description":"Contains up-to-date information relating to an auto-deployed VM, including\nits status and (potentially) an error message.\n","title":"Report of a VM's deployment status","required":["status"],"x-vmw-nsx-module":"ClusterNodeVMDeployment","type":"object","properties":{"status":{"enum":["UNKNOWN_STATE","VM_DEPLOYMENT_QUEUED","VM_DEPLOYMENT_IN_PROGRESS","VM_DEPLOYMENT_FAILED","VM_POWER_ON_IN_PROGRESS","VM_POWER_ON_FAILED","WAITING_TO_REGISTER_VM","VM_REGISTRATION_FAILED","VM_WAITING_TO_CLUSTER","VM_WAITING_TO_COME_ONLINE","VM_ONLINE_FAILED","VM_CLUSTERING_IN_PROGRESS","VM_CLUSTERING_FAILED","VM_CLUSTERING_SUCCESSFUL","WAITING_TO_UNDEPLOY_VM","VM_DECLUSTER_IN_PROGRESS","VM_DECLUSTER_FAILED","VM_DECLUSTER_SUCCESSFUL","VM_POWER_OFF_IN_PROGRESS","VM_POWER_OFF_FAILED","VM_UNDEPLOY_IN_PROGRESS","VM_UNDEPLOY_FAILED","VM_UNDEPLOY_SUCCESSFUL"],"type":"string","description":"Status of the addition or deletion of an auto-deployed cluster node VM.\n","title":"Auto-deployed VM's deployment status"},"deployment_progress_state":{"$ref":"#/definitions/VMDeploymentProgressState"},"failure_message":{"type":"string","description":"In case of auto-deployment-related failure, an error message will be\nstored here.\n","title":"Error message for failure"},"failure_code":{"format":"int64","type":"integer","description":"In case of auto-deployment-related failure, the code for the error will\nbe stored here.\n","title":"Error code for failure"}}},"PublicClientInfo":{"description":"Parameters needed to specify a PKCE OAuth2 client.","title":"Information for a PKCE OAuth2 client","required":["default_org_id","redirect_uris","gss_org_id","base_url","client_id","ea_org_id","sre_org_id"],"x-vmw-nsx-module":"ApplianceModes","type":"object","properties":{"default_org_id":{"type":"string","description":"The org id for this client-id, typically a UUID.","title":"The org id for this client-id"},"redirect_uris":{"items":{"type":"string"},"type":"array","description":"The set of redirect URI's configured for this client_id.","title":"The set of redirect URI's configured for this client_id"},"client_id":{"type":"string","description":"The client-id to use with CSP, identified with base_url.","title":"The client-id to use with CSP"},"ea_org_id":{"type":"string","description":"The symbolic org id for enterprise admins.","title":"The symbolic org id for enterprise admins"},"sre_org_id":{"type":"string","description":"The symbolic org id SRE (Site Reliability Engineer).","title":"The symbolic org id for SRE (Site Reliability Engineer)"},"gss_org_id":{"type":"string","description":"The symbolic org id for GSS (Global Support Services).","title":"The symbolic org id for GSS (Global Support Services)"},"base_url":{"type":"string","description":"Protocol and domain name (or IP address) of CSP, for e.g., https://console.cloud.vmware.com.","title":"CSP base URL"}}},"EtherTypeNSService":{"x-vmw-nsx-module":"Types","allOf":[{"$ref":"#/definitions/NSServiceElement"},{"required":["ether_type"],"x-vmw-nsx-module":"Types","type":"object","properties":{"ether_type":{"format":"int64","type":"integer","description":"Type of the encapsulated protocol","title":"Type of the encapsulated protocol"}}}],"description":"An NSService element that represents an ethertype protocol","title":"An NSService element that represents an ethertype protocol"},"VtepCsvListResult":{"x-vmw-nsx-module":"AggSvcLogicalSwitch","allOf":[{"$ref":"#/definitions/CsvListResult"},{"x-vmw-nsx-module":"AggSvcLogicalSwitch","type":"object","properties":{"last_update_timestamp":{"description":"Timestamp when the data was last updated; unset if data source has never updated the data.","format":"int64","readOnly":true,"type":"integer"},"results":{"items":{"$ref":"#/definitions/VtepTableCsvRecord"},"type":"array"}}}]},"DirectoryDomainSyncSettings":{"x-vmw-nsx-module":"DirectoryService","type":"object","description":"Domain synchronization settings","properties":{"sync_delay_in_sec":{"description":"Sync delay after Directory domain has been successfully created.\nif delay is -1, initial full sync will not be triggered.\n","title":"Sync delay (in second).","default":30,"format":"int32","maximum":600,"minimum":-1,"type":"integer"},"full_sync_cron_expr":{"type":"string","description":"Directory domain full synchronization schedule using cron expression. For example, cron expression \"0 0 12 ? * SUN *\" means full sync is scheduled every Sunday midnight. If this object is null, it means there is no background cron job running for full sync.","title":"Full synchronization cron expression"},"delta_sync_interval":{"description":"Directory domain delta synchronization interval time between two delta sync in minutes.","title":"Delta synchronization inverval in minutes","default":180,"format":"int64","maximum":720,"minimum":5,"type":"integer"}},"title":"Domain synchronization settings"},"SIServiceProfileListResult":{"x-vmw-nsx-module":"ServiceInsertion","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"ServiceInsertion","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/BaseServiceProfile"},"readOnly":true,"type":"array","description":"List of the Service-Insertion Services. The list has to be homogenous.","title":"Service list"}}}],"description":"Service Insertion Service Profile List","title":"Service Insertion Service Profile List"},"ComputeManagerTopology":{"description":"Details where NVDS will be migrated to","title":"Details where NVDS will be migrated to","required":["dvswitch","compute_manager_id"],"x-vmw-nsx-module":"NvdsUpgradeReadinessCheck","type":"object","properties":{"dvswitch":{"items":{"$ref":"#/definitions/VdsTopology"},"type":"array","description":"Datacenter, VDS mapping","title":"Datacenter, VDS mapping"},"compute_manager_id":{"type":"string","description":"Identifier of vcenter where VDS will be created","title":"Identifier of vcenter where VDS will be created"}}},"Uplink":{"description":"Object to identify an uplink based on its type and name","title":"Object to identify an uplink based on its type and name","required":["uplink_name","uplink_type"],"x-vmw-nsx-module":"UplinkHostSwitchProfile","type":"object","properties":{"uplink_name":{"type":"string","description":"Name of this uplink","title":"Name of this uplink"},"uplink_type":{"enum":["PNIC","LAG"],"type":"string","description":"Type of the uplink","title":"Type of the uplink"}}},"NodeTime":{"description":"Node system time in UTC","title":"Node system time in UTC","required":["system_datetime"],"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"system_datetime":{"type":"string","description":"Datetime string in UTC"}}},"TraceflowObservationRelayedLogical":{"x-vmw-nsx-module":"Traceflow","allOf":[{"$ref":"#/definitions/TraceflowObservation"},{"x-vmw-nsx-module":"Traceflow","type":"object","properties":{"message_type":{"description":"This field specified the message type of the relay service REQUEST - The relay service will relay a request message to the destination server REPLY - The relay service will relay a reply message to the client","title":"The type of the relay service","default":"REQUEST","enum":["REQUEST","REPLY"],"readOnly":true,"type":"string"},"dst_server_address":{"description":"This field specified the IP address of the destination which the packet will be relayed.","format":"ip","readOnly":true,"type":"string"},"logical_comp_uuid":{"readOnly":true,"type":"string","description":"This field specified the logical component that relay service located.","title":"The id of the component which relay service located"},"relay_server_address":{"description":"This field specified the IP address of the relay service.","format":"ip","readOnly":true,"type":"string"}}}]},"PortConnectionRouter":{"x-vmw-nsx-module":"PortConnection","allOf":[{"$ref":"#/definitions/PortConnectionEntity"},{"x-vmw-nsx-module":"PortConnection","type":"object","properties":{"uplink_ports":{"items":{"$ref":"#/definitions/LogicalRouterPort"},"readOnly":true,"type":"array","description":"Uplink ports of the Logical Router.","title":"Uplink ports of the Logical Router."},"downlink_ports":{"items":{"$ref":"#/definitions/LogicalRouterPort"},"readOnly":true,"type":"array","description":"Downlink ports of the Logical Router.","title":"Downlink ports of the Logical Router."}}}],"description":"Port Connection Logical Router Entity","title":"Port Connection Logical Router Entity"},"BgpNeighborsStatusListResult":{"x-vmw-nsx-module":"AggSvcLogicalRouter","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"AggSvcLogicalRouter","type":"object","properties":{"logical_router_name":{"readOnly":true,"type":"string","description":"Name of the logical router","title":"Name of the logical router"},"last_update_timestamp":{"description":"Timestamp when the data was last updated, unset if data source has never updated the data.","format":"int64","readOnly":true,"type":"integer"},"logical_router_id":{"readOnly":true,"type":"string","description":"Logical router id","title":"Logical router id"},"results":{"description":"Status of BGP neighbors of the logical router","title":"Status of BGP neighbors of the logical router","items":{"$ref":"#/definitions/BgpNeighborStatus"},"readOnly":true,"additionalProperties":false,"type":"array"}}}]},"PhysicalServerListResult":{"x-vmw-nsx-module":"PhysicalServer","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"PhysicalServer","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/PhysicalServer"},"type":"array","description":"List of physical servers.","title":"List of physical servers"}}}]},"Traceflow":{"x-vmw-nsx-module":"Traceflow","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"Traceflow","type":"object","properties":{"operation_state":{"readOnly":true,"enum":["IN_PROGRESS","FINISHED","FAILED"],"type":"string","description":"Represents the traceflow operation state","title":"Represents the traceflow operation state"},"logical_counters":{"$ref":"#/definitions/TraceflowObservationCounters"},"timeout":{"description":"Maximum time (in ms) the management plane will be waiting for this traceflow round. Upper limit for federation case is 90000, for non-federation case is 15000, the maximum is set to 90000 as the higher of the two cases.","title":"Timeout (in ms) for traceflow observations result list","format":"int64","maximum":90000,"readOnly":true,"minimum":5000,"type":"integer"},"result_overflowed":{"readOnly":true,"type":"boolean","description":"A flag, when set true, indicates some observations were deleted from the result set.","title":"A flag, when set true, indicates some observations were deleted from the result set."},"lport_id":{"readOnly":true,"type":"string","description":"id of the source logical port used for injecting the traceflow packet","title":"id of the source logical port used for injecting the traceflow packet"},"counters":{"$ref":"#/definitions/TraceflowObservationCounters"},"request_status":{"readOnly":true,"enum":["SUCCESS","TIMEOUT","SOURCE_PORT_NOT_FOUND","DATA_PATH_NOT_READY","CONNECTION_ERROR","UNKNOWN"],"type":"string","description":"The status of the traceflow RPC request. SUCCESS - The traceflow request is sent successfully. TIMEOUT - The traceflow request gets timeout. SOURCE_PORT_NOT_FOUND - The source port of the request cannot be found. DATA_PATH_NOT_READY - The datapath component cannot be ready to receive request. CONNECTION_ERROR - There is connection error on datapath component. UNKNOWN - The status of traceflow request cannot be determined.","title":"Traceflow request status"},"analysis":{"items":{"type":"string"},"readOnly":true,"type":"array","description":"Traceflow result analysis notes","title":"Traceflow result analysis notes"},"id":{"readOnly":true,"type":"string","description":"The id of the traceflow round","title":"The id of the traceflow round"}}}]},"DhcpServerStatus":{"x-vmw-nsx-module":"AggSvcDhcp","required":["service_status","active_node"],"type":"object","properties":{"error_message":{"type":"string","description":"Error message, if available","title":"Error message, if available"},"service_status":{"enum":["UP","DOWN","ERROR","NO_STANDBY"],"type":"string","description":"UP means the dhcp service is working fine on both active transport-node\nand stand-by transport-node (if have), hence fail-over can work at this\ntime if there is failure happens on one of the transport-node;\nDOWN means the dhcp service is down on both active transport-node and\nstand-by node (if have), hence the dhcp-service will not repsonse any\ndhcp request;\nError means error happens on transport-node(s) or no status is reported from\ntransport-node(s). The dhcp service may be working (or not working);\nNO_STANDBY means dhcp service is working in one of the transport node while\nnot in the other transport-node (if have). Hence if the dhcp service in\nthe working transport-node is down, fail-over will not happen and the\ndhcp service will go down.\n"},"stand_by_node":{"type":"string","description":"uuid of stand_by transport node. null if non-HA mode","title":"uuid of stand_by transport node. null if non-HA mode"},"active_node":{"type":"string","description":"uuid of active transport node","title":"uuid of active transport node"}}},"HttpsProtocol":{"x-vmw-nsx-module":"MISSING_MODULE","allOf":[{"$ref":"#/definitions/Protocol"},{"x-vmw-nsx-module":"MISSING_MODULE","required":["sha256_thumbprint"],"type":"object","properties":{"sha256_thumbprint":{"type":"string","description":"SSL thumbprint of server","title":"SSL thumbprint of server"},"authentication_scheme":{"$ref":"#/definitions/BasicAuthenticationScheme"}}}]},"FeaturePermission":{"description":"Feature Permission","title":"Feature Permission","required":["feature","permission"],"x-vmw-nsx-module":"AAA","type":"object","properties":{"is_execute_recommended":{"readOnly":true,"type":"boolean","description":"Is execute recommended","title":"Is execute recommended"},"feature_name":{"type":"string","description":"Feature Name","title":"Feature Name"},"permission":{"enum":["crud","read","execute","none"],"type":"string","description":"Permission","title":"Permission"},"is_internal":{"readOnly":true,"type":"boolean","description":"Is internal","title":"Is internal"},"feature":{"type":"string","description":"Feature Id","title":"Feature Id"},"feature_description":{"type":"string","description":"Feature Description","title":"Feature Description"}}},"LegendWidgetConfiguration":{"x-vmw-nsx-module":"NsxDashboard","allOf":[{"$ref":"#/definitions/WidgetConfiguration"},{"required":["layout","source_widget_id"],"x-vmw-nsx-module":"NsxDashboard","type":"object","properties":{"layout":{"$ref":"#/definitions/Legend"},"source_widget_id":{"maxLength":255,"type":"string","description":"Id of source widget, if any. Id should be a valid id of an existing widget. This property can be used to identify the source of the data for this legend widget.","title":"Id of source widget for this legend widget"}}}],"description":"Represents configuration for Legend widget. For this widget the data source is not applicable. This widget can be use to add the Legend inside the dashboard container.","title":"Legend widget Configuration"},"SourceNsxApiEndpoint":{"x-vmw-nsx-module":"Migration","type":"object","description":"Details about an existing NSX manager to be migrated","properties":{"vc_port":{"description":"VC port that will be used to fetch details.","format":"int32","default":443,"title":"VC port","readOnly":false,"type":"integer"},"vc_username":{"readOnly":false,"type":"string","description":"Username for connecting to VC.","title":"Username for VC"},"vc_ip":{"readOnly":false,"format":"hostname-or-ip","type":"string","description":"IP address or host name of VC.","title":"VC IP address or host name"},"ip":{"readOnly":false,"format":"hostname-or-ip","type":"string","description":"IP address or hostname of a source NSX API endpoint. This field is not applicable in case of vSphere network migration.","title":"Source NSX API endpoint IP address"},"auth_token":{"readOnly":false,"type":"string","description":"Auth token used to make REST calls to the source NSX API endpoint. This field is not applicable in case of vSphere network migration. Please generate the token with a sufficiently large duration so that it does not expire in the middle of the migration. If it does expire, then the token needs to be refreshed manually by invoking this API again with a new token. Alternatively, you can provide the username/password of the source NSX.","title":"Source NSX auth token"},"nsx_syncrole":{"readOnly":true,"type":"string","description":"Signifies Universal Sync role status (STANDALONE, PRIMARY, SECONDARY) of a source NSX API endpoint.","title":"Source NSX API endpoint Universal Sync role"},"vc_version":{"readOnly":true,"type":"string","description":"Build version of VC.","title":"VC build version"},"nsx_username":{"readOnly":false,"type":"string","description":"Username for connecting to NSX manager. This field is not applicable in case of vSphere network migration.","title":"Username for NSX manager"},"nsx_version":{"readOnly":true,"type":"string","description":"Build version (major, minor, patch) of a source NSX API endpoint.","title":"Source NSX API endpoint build version"},"nsx_password":{"readOnly":false,"type":"string","description":"Password for connecting to NSX manager. This field is not applicable in case of vSphere network migration.","title":"Password for NSX manager"},"vc_password":{"readOnly":false,"type":"string","description":"Password for connecting to VC.","title":"Password for VC"}},"title":"Source NSX manager details"},"RouteMapSequenceMatch":{"x-vmw-nsx-module":"Routing","type":"object","description":"Match sequence in route map which is used for matching routes.\nIP prefix lists and match community expression are mutually\nexclusive fields, one of them must be provided.\n","properties":{"match_community_expression":{"$ref":"#/definitions/CommunityMatchExpression"},"ip_prefix_lists":{"description":"IPPrefixList Identifiers for RouteMap Sequence Match Criteria","title":"IPPrefixList Identifiers for RouteMap Sequence Match Criteria","minItems":1,"items":{"type":"string"},"maxItems":500,"type":"array"}}},"Protocol":{"discriminator":"name","x-vmw-nsx-module":"MISSING_MODULE","required":["name"],"type":"object","properties":{"name":{"enum":["http","https","scp","sftp"],"type":"string","description":"Protocol name","title":"Protocol name"}}},"NodeLogProperties":{"x-vmw-nsx-module":"MISSING_MODULE","allOf":[{"$ref":"#/definitions/Resource"},{"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"last_modified_time":{"description":"Last modified time expressed in milliseconds since epoch","format":"int64","readOnly":true,"type":"integer"},"log_size":{"readOnly":true,"format":"int64","type":"integer","description":"Size of log file in bytes","title":"Size of log file in bytes"},"log_name":{"readOnly":true,"type":"string","description":"Name of log file","title":"Name of log file"}}}],"description":"Node log properties","title":"Node log properties"},"LogicalRouterDownLinkPort":{"x-vmw-nsx-module":"LogicalRouterPorts","allOf":[{"$ref":"#/definitions/LogicalRouterPort"},{"x-vmw-nsx-module":"LogicalRouterPorts","required":["subnets"],"type":"object","properties":{"subnets":{"minItems":1,"items":{"$ref":"#/definitions/IPSubnet"},"type":"array","description":"Logical router port subnets","title":"Logical router port subnets"},"linked_logical_switch_port_id":{"$ref":"#/definitions/ResourceReference"},"ndra_profile_id":{"type":"string","description":"Identifier of Neighbor Discovery Router Advertisement profile\nassociated with port. When NDRA profile id is associated at\nboth the port level and logical router level, the profile id\nspecified at port level takes the precedence.\n","title":"Identifier for NDRA profile on the port"},"mac_address":{"readOnly":true,"type":"string","description":"MAC address","title":"MAC address"},"urpf_mode":{"description":"Unicast Reverse Path Forwarding mode","default":"STRICT","enum":["NONE","STRICT"],"type":"string"},"routing_policies":{"items":{"$ref":"#/definitions/RoutingPolicy"},"type":"array","description":"Routing policies used to specify how the traffic, which matches the\npolicy routes, will be processed.\n","maxItems":1,"title":"Routing policies"},"enable_multicast":{"type":"boolean","description":"If this flag is set to true - it will enable multicast on the\ndownlink interface. If this flag is set to false - it will disable\nmulticast on the downlink interface. This is supported only on\nTier0 downlinks. Default value for Tier0 downlink will be true.\n","title":"Flag to enable/disable Multicast"},"ndra_prefix_config":{"items":{"$ref":"#/definitions/NDRAPrefixConfig"},"type":"array","description":"Configuration to override the neighbor discovery router advertisement\nprefix time parameters at the subnet level. Note that users are allowed\nto override the prefix time only for IPv6 subnets which are configured\non the port.\n"}}}]},"FederationConfiguration":{"description":"Federation configuration.","title":"Federation configuration","required":["epoch","id","sites"],"x-vmw-nsx-module":"SiteManagerModule","type":"object","properties":{"epoch":{"format":"int64","type":"integer","description":"Epoch","title":"Epoch"},"id":{"type":"string","description":"Federation id","title":"Federation id"},"sites":{"items":{"$ref":"#/definitions/FederationSite"},"type":"array","description":"Sites","title":"Sites"}}},"Tag":{"x-vmw-nsx-module":"Common","type":"object","description":"Arbitrary key-value pairs that may be attached to an entity","properties":{"scope":{"description":"Tag searches may optionally be restricted by scope","title":"Tag scope","default":"","readOnly":false,"maxLength":128,"type":"string"},"tag":{"default":"","readOnly":false,"type":"string","description":"Identifier meaningful to user with maximum length of 256 characters","title":"Tag value"}},"title":"Arbitrary key-value pairs that may be attached to an entity"},"L2VpnServiceListResult":{"x-vmw-nsx-module":"L2VPN","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"L2VPN","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/L2VpnService"},"type":"array","description":"L2VPN serivce list result","title":"L2VPN serivce list result"}}}],"description":"Paginated list all the L2VPN services.","title":"List all L2VPN services"},"LbNodeUsage":{"description":"Node usage for load balancer contains basic information and LB entity\nusages and capacity for the given node.\n","title":"Node usage for load balancer","required":["node_id","type"],"discriminator":"type","x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"node_id":{"type":"string","description":"The property identifies the node UUID for load balancer node usage.\n","title":"The UUID of the node for load balancer node usage"},"type":{"description":"The property identifies the load balancer node usage type.\n","enum":["LbEdgeNodeUsage"],"type":"string"}}},"StaticRouteListResult":{"x-vmw-nsx-module":"Routing","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"Routing","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/StaticRoute"},"type":"array","description":"Paginated list of static routes","title":"Paginated list of static routes"}}}]},"LogicalPortMirrorDestination":{"x-vmw-nsx-module":"PortMirroring","allOf":[{"$ref":"#/definitions/MirrorDestination"},{"x-vmw-nsx-module":"PortMirroring","required":["port_ids"],"type":"object","properties":{"port_ids":{"description":"Destination logical port identifier list.","title":"Destination logical port identifier list.","minItems":1,"items":{"type":"string"},"maxItems":3,"type":"array"}}}]},"VtepLabelPoolUsage":{"x-vmw-nsx-module":"VtepLabel","type":"object","description":"Pool usage statistics in a pool","properties":{"total_ids":{"readOnly":true,"format":"int64","type":"integer","description":"Total number of IDs in a pool","title":"Total number of IDs in a pool"},"allocated_ids":{"readOnly":true,"format":"int64","type":"integer","description":"Total number of allocated IDs in a pool","title":"Total number of allocated IDs in a pool"},"free_ids":{"readOnly":true,"format":"int64","type":"integer","description":"Total number of free IDs in a pool","title":"Total number of free IDs in a pool"}}},"FirewallSectionsSummaryList":{"x-vmw-nsx-module":"FirewallSummary","type":"object","properties":{"last_compute_time":{"description":"Timestamp of the last computation, in epoch milliseconds.","format":"int64","readOnly":true,"type":"integer"},"sections_summary":{"items":{"$ref":"#/definitions/FirewallSectionsSummary"},"readOnly":true,"type":"array","description":"List of firewall sections summary.","title":"List of the firewall sections summary"}}},"ClusterProfileListResult":{"x-vmw-nsx-module":"ClusterProfile","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"ClusterProfile","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/ClusterProfile"},"readOnly":true,"type":"array","description":"Cluster Profile Results","title":"Cluster Profile Results"}}}],"description":"Cluster Profile queries result","title":"Cluster Profile queries result"},"UpgradeUnitStatus":{"x-vmw-nsx-module":"Upgrade","type":"object","properties":{"status":{"readOnly":true,"enum":["SUCCESS","FAILED","IN_PROGRESS","NOT_STARTED","PAUSING","PAUSED"],"type":"string","description":"Status of upgrade unit","title":"Status of upgrade unit"},"errors":{"items":{"type":"string"},"readOnly":true,"type":"array","description":"List of errors occurred during upgrade of this upgrade unit","title":"List of errors occurred during upgrade of this upgrade unit"},"display_name":{"readOnly":true,"type":"string","description":"Name of upgrade unit","title":"Name of upgrade unit"},"percent_complete":{"readOnly":true,"type":"number","description":"Indicator of upgrade progress in percentage","title":"Indicator of upgrade progress in percentage"},"id":{"readOnly":true,"type":"string","description":"Identifier of upgrade unit","title":"UUID of upgrade unit"},"metadata":{"items":{"$ref":"#/definitions/KeyValuePair"},"readOnly":true,"type":"array","description":"Metadata about upgrade unit","title":"Metadata about upgrade unit"}}},"PnicMirrorDestination":{"x-vmw-nsx-module":"PortMirroring","allOf":[{"$ref":"#/definitions/MirrorDestination"},{"x-vmw-nsx-module":"PortMirroring","required":["dest_pnics","node_id"],"type":"object","properties":{"dest_pnics":{"description":"Physical NIC device names to which to send the mirrored packets","title":"Physical NIC device names to which to send the mirrored packets","minItems":1,"items":{"type":"string"},"maxItems":3,"type":"array"},"node_id":{"type":"string","description":"Transport node to which to send the mirrored packets","title":"Transport node to which to send the mirrored packets"}}}]},"EdgeClusterMemberTransportNode":{"x-vmw-nsx-module":"EdgeClusters","required":["member_index","transport_node_id"],"type":"object","properties":{"member_index":{"format":"int32","type":"integer","description":"System generated index for cluster member","title":"System generated index for cluster member"},"transport_node_id":{"type":"string","description":"Identifier of the transport node backed by an Edge node","title":"UUID of edge transport node"}}},"L2ForwarderStatusPerNode":{"x-vmw-nsx-module":"AggSvcL2Forwarder","type":"object","properties":{"transport_node":{"$ref":"#/definitions/ResourceReference"},"high_availability_status":{"readOnly":true,"enum":["ACTIVE","STANDBY","DOWN","SYNC","UNKNOWN"],"type":"string","description":"High Availability status of a service router on the edge node.\n","title":"Service router's HA status"}}},"PoolMemberSettingList":{"description":"List of PoolMemberSetting","title":"List of PoolMemberSetting","required":["members"],"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"members":{"items":{"$ref":"#/definitions/PoolMemberSetting"},"type":"array","description":"List of pool member settings to be passed to add, update and remove APIs\n","title":"List of pool member settings to be passed to add, update and remove APIs\n"}}},"DSExcludeList":{"x-vmw-nsx-module":"DistributedServices","allOf":[{"$ref":"#/definitions/ManagedResource"},{"required":["members"],"x-vmw-nsx-module":"DistributedServices","type":"object","properties":{"member_count":{"readOnly":true,"format":"int64","type":"integer","description":"Total number of members present in Exclude List.","title":"Total Member Count"},"members":{"description":"List of members in Exclusion List","title":"Member list","items":{"$ref":"#/definitions/ResourceReference"},"readOnly":false,"maxItems":1000,"type":"array"}}}],"description":"List of entities excluded for enforcing a service or a feature.","title":"Exclusion List"},"SourceEntityResult":{"x-vmw-nsx-module":"ServiceInsertion","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"ServiceInsertion","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/SourceEntity"},"readOnly":true,"type":"array","description":"List of the Service Entities","title":"Service Entity List"}}}],"description":"Service Entity List","title":"Service Entity List"},"NatCounters":{"x-vmw-nsx-module":"AggSvcLogicalRouter","type":"object","properties":{"total_packets":{"readOnly":true,"format":"int64","type":"integer","description":"The number of packets","title":"The number of packets"},"total_bytes":{"readOnly":true,"format":"int64","type":"integer","description":"The number of bytes","title":"The number of bytes"},"active_sessions":{"readOnly":true,"format":"int64","type":"integer","description":"The number of active sessions","title":"The number of active sessions"}}},"HostSwitchState":{"x-vmw-nsx-module":"TransportNode","type":"object","description":"Host Switch State","properties":{"host_switch_type":{"default":"NVDS","enum":["NVDS","VDS"],"type":"string","description":"VDS represents VMware vSphere Distributed Switch from vSphere that is used as HostSwitch through TransportNode or TransportNodeProfile configuration. When VDS is used as a HostSwitch, Hosts have to be added to VDS from vSphere and VDS instance is created on Hosts. To configure NSX on such hosts, you can use this VDS as a HostSwitch from NSX manager. vCenter has the ownership of MTU, LAG, NIOC and LLDP configuration of such VDS backed HostSwitch. Remaining configuration (e.g. UplinkHostswitchProfile) will be managed by NSX. NVDS represents NSX Virtual Switch which is NSX native HostSwitch. All configurations of NVDS will be managed by NSX.","title":"Type of HostSwitch"},"host_switch_id":{"readOnly":true,"type":"string","description":"External ID of the HostSwitch","title":"External ID of the HostSwitch"},"endpoints":{"items":{"$ref":"#/definitions/Endpoint"},"readOnly":true,"type":"array","description":"List of virtual tunnel endpoints which are configured on this switch","title":"List of virtual tunnel endpoints which are configured on this switch"},"transport_zone_ids":{"items":{"type":"string"},"readOnly":true,"type":"array","description":"List of Ids of TransportZones this HostSwitch belongs to","title":"List of Ids of TransportZones this HostSwitch belongs to"},"host_switch_name":{"readOnly":true,"type":"string","description":"The name must be unique among all host switches specified in a given Transport Node.","title":"HostSwitch name. This name will be used to reference this HostSwitch."}},"title":"Host Switch State"},"HostNode":{"x-vmw-nsx-module":"FabricNode","allOf":[{"$ref":"#/definitions/Node"},{"required":["os_type"],"x-vmw-nsx-module":"FabricNode","type":"object","properties":{"discovered_node_id":{"readOnly":true,"type":"string","description":"Id of discovered node which was converted to create this node","title":"Discovered node id"},"windows_install_location":{"type":"string","description":"Specify an installation folder to install the NSX kernel modules for Windows Server. By default, it is C:\\Program Files\\VMware\\NSX\\.","title":"Install location of Windows Server on baremetal being managed by NSX"},"managed_by_server":{"readOnly":true,"type":"string","description":"The id of the vCenter server managing the ESXi type HostNode","title":"Id of vCenter server managing the HostNode"},"host_credential":{"$ref":"#/definitions/HostNodeLoginCredential"},"os_version":{"type":"string","description":"Version of the hypervisor operating system","title":"Hypervisor OS version"},"os_type":{"enum":["ESXI","RHELKVM","RHELSERVER","WINDOWSSERVER","RHELCONTAINER","UBUNTUKVM","UBUNTUSERVER","HYPERV","CENTOSKVM","CENTOSSERVER","CENTOSCONTAINER","SLESKVM","SLESSERVER","OELSERVER"],"type":"string","description":"Hypervisor type, for example ESXi or RHEL KVM","title":"Hypervisor OS type"},"compute_collection_id":{"readOnly":true,"type":"string","description":"Id of the compute collection to which discovered node belongs.","title":"Compute collection id"},"maintenance_mode_state":{"readOnly":true,"enum":["OFF","ENTERING","ON"],"type":"string","description":"Indicates host node's maintenance mode state. The state is ENTERING\nwhen a task to put the host in maintenance-mode is in progress.\n","title":"Maintenance mode state"}}}],"description":"Host node","title":"Host node"},"KeyStoreInfo":{"x-vmw-nsx-module":"NsxDashboard","type":"object","description":"Key Store information about the url alias or datasource.","properties":{"keystore":{"type":"string","description":"A location of the keystor file which stores private key and identity certificates that will be presented to both parties (server or client) for verification.","title":"A location of the keystore file"},"keystore_alias":{"type":"string","description":"Its an alias specified when an entity is added to the keystore.","title":"An alias is used to uniquely identifies the entry in keystore"},"truststore":{"type":"string","description":"A location of the trust store file which stores the certificate from CA that verify the certificate presented by the server in SSL connection.","title":"A location of the trust store file."},"keystore_phrase":{"type":"string","description":"A location of the key store pass phrase file.","title":"A location of the key store pass phrase file."}},"title":"KeyStoreInfo"},"L4PortSetNSService":{"x-vmw-nsx-module":"Types","allOf":[{"$ref":"#/definitions/NSServiceElement"},{"required":["l4_protocol"],"x-vmw-nsx-module":"Types","type":"object","properties":{"destination_ports":{"items":{"description":"Examples- Single port \"8080\", Range of ports \"8090-8095\"\n","format":"port-or-range","type":"string"},"type":"array","description":"Number of values should not exceed 15, ranges count as 2 values.\n","maxItems":15,"title":"Destination ports"},"l4_protocol":{"enum":["TCP","UDP"],"type":"string"},"source_ports":{"items":{"description":"Examples- Single port \"8080\", Range of ports \"8090-8095\"\n","format":"port-or-range","type":"string"},"type":"array","description":"Number of values should not exceed 15, ranges count as 2 values.\n","maxItems":15,"title":"Source ports"}}}],"description":"L4PortSet can be specified in comma separated notation of parts. Parts of a\nL4PortSet includes single integer or range of port in hyphen notation.\nExample of a PortSet: \"22, 33-70, 44\".\n","title":"An NSService element that represents TCP or UDP protocol"},"MPResourceMetadata":{"description":"Resource metadata.\n","title":"Resource metadata.\n","required":["key"],"x-vmw-nsx-module":"MPPolicyMigration","type":"object","properties":{"value":{"type":"string","description":"Resource metadata value.","title":"Resource metadata value."},"key":{"type":"string","description":"It has to be one of the attribute of targeted policy intent.","title":"Resource metadata key."}}},"LogicalPortState":{"description":"Contians realized state of the logical port. For example, transport node\non which the port is located, discovered and realized address bindings of\nthe logical port.\n","title":"Realized state of the logical port.","required":["id"],"x-vmw-nsx-module":"LogicalPort","type":"object","properties":{"transport_node_ids":{"items":{"type":"string"},"type":"array","description":"Identifiers of the transport node where the port is located","title":"Identifiers of the transport node where the port is located"},"attachment":{"$ref":"#/definitions/LogicalPortAttachmentState"},"duplicate_bindings":{"items":{"$ref":"#/definitions/DuplicateAddressBindingEntry"},"type":"array","description":"If any address binding discovered on the port is also found on\nother port on the same logical switch, then it is included in\nthe duplicate bindings list along with the ID of the port with\nwhich it conflicts.\n","title":"Duplicate logical port address bindings"},"discovered_bindings":{"items":{"$ref":"#/definitions/AddressBindingEntry"},"type":"array","description":"Contains the list of address bindings for a logical port that were\nautomatically dicovered using various snooping methods like ARP, DHCP\netc.\n","title":"Logical port bindings discovered automatically"},"id":{"type":"string","description":"Id of the logical port","title":"Id of the logical port"},"realized_bindings":{"items":{"$ref":"#/definitions/AddressBindingEntry"},"type":"array","description":"List of logical port bindings that are realized. This list may be\npopulated from the discovered bindings or manual user specified bindings.\nThis binding configuration can be used by features such as firewall,\nspoof-guard, traceflow etc.\n","title":"Realized logical port bindings"}}},"L2VPNTapTrafficStatistics":{"x-vmw-nsx-module":"L2VPNStatistics","type":"object","description":"TAP (Terminal access point) traffic statistics for L2VPN.","properties":{"packets_out":{"readOnly":true,"format":"int64","type":"integer","description":"Total number of outgoing packets.","title":"Packets out"},"bytes_in":{"readOnly":true,"format":"int64","type":"integer","description":"Total number of incoming bytes.","title":"Bytes in"},"packets_sent_error":{"readOnly":true,"format":"int64","type":"integer","description":"Total number of packets dropped while sending for any reason.","title":"Packets sent error"},"packets_receive_error":{"readOnly":true,"format":"int64","type":"integer","description":"Total number of incoming packets dropped.","title":"packets recieved error"},"packets_in":{"readOnly":true,"format":"int64","type":"integer","description":"Total number of incoming packets.","title":"Packets in"},"bytes_out":{"readOnly":true,"format":"int64","type":"integer","description":"Total number of outgoing bytes.","title":"Bytes out"}},"title":"L2VPN TAP (Terminal access point) traffic statistics"},"NodeUserPropertiesListResult":{"x-vmw-nsx-module":"MISSING_MODULE","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/NodeUserProperties"},"type":"array","description":"List of node users","title":"List of node users"}}}],"description":"Node users list results","title":"Node users list results"},"MPResource":{"description":"List of Manager Ids to migrate.\n","title":"Contains migration api request parameters\n","required":["resource_ids","type"],"x-vmw-nsx-module":"MPPolicyMigration","type":"object","properties":{"resource_ids":{"items":{"$ref":"#/definitions/MPResourceDetails"},"type":"array","description":"Manager and policy resource id array.\n"},"type":{"type":"string","description":"Manager resource type to migrate.\n","title":"Manager resource type to migrate."}}},"LabelValueConfiguration":{"x-vmw-nsx-module":"NsxDashboard","allOf":[{"$ref":"#/definitions/WidgetConfiguration"},{"required":["properties"],"x-vmw-nsx-module":"NsxDashboard","type":"object","properties":{"layout":{"$ref":"#/definitions/Layout"},"navigation":{"maxLength":1024,"type":"string","description":"Hyperlink of the specified UI page that provides details.","title":"Navigation to a specified UI page"},"sub_type":{"enum":["VERTICALLY_ALIGNED","HORIZONTALLY_ALIGNED"],"type":"string","description":"A sub-type of LabelValueConfiguration. If sub-type is not specified the parent type is rendered. For VERTICALLY_ALIGNED sub_type, the value is placed below the label. For HORIZONTALLY_ALIGNED sub_type, the value is placed right hand side of the label.","title":"Sub-type of the LabelValueConfiguration"},"properties":{"items":{"$ref":"#/definitions/PropertyItem"},"type":"array","description":"An array of label-value properties.","title":"Rows"}}}],"description":"Represents a Label-Value widget configuration","title":"Label Value Dashboard Widget Configuration"},"DADProfile":{"x-vmw-nsx-module":"Routing","description":"Duplicate address detection profile.\n","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"Routing","type":"object","properties":{"wait_time":{"description":"The time duration in seconds, to wait for Neighbor advertisement\nafter sending the Neighbor solicitation message.\n","title":"Wait time","default":1,"format":"int64","maximum":60,"minimum":0,"type":"integer"},"ns_retries":{"description":"Number of Neighbor solicitation packets generated before completing the\nDuplicate address detection process.\n","title":"NS retries count","default":3,"format":"int64","maximum":10,"minimum":0,"type":"integer"},"dad_mode":{"description":"DAD Mode","default":"LOOSE","enum":["LOOSE","STRICT"],"type":"string"}}}]},"IssuerSerialNumber":{"x-vmw-nsx-module":"CertificateManager","type":"object","properties":{"serial_numbers":{"items":{"type":"string"},"type":"array","description":"List of Certificate Serial Numbers issued by the specified issuers.","title":"Certificate Serial Numbers"},"issuer":{"type":"string","description":"Issuer Distinguished Name of the revoked certificates.","title":"Issuer Distinguished Name (DN)"}}},"MigrationUnitGroupAggregateInfo":{"x-vmw-nsx-module":"Migration","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"Migration","required":["group"],"type":"object","properties":{"status":{"readOnly":true,"enum":["SUCCESS","FAILED","IN_PROGRESS","NOT_STARTED","PAUSING","PAUSED"],"type":"string","description":"Migration status of migration unit group","title":"Migration status of migration unit group"},"failed_count":{"readOnly":true,"format":"int32","type":"integer","description":"Number of nodes in the migration unit group that failed migration","title":"Number of nodes in the migration unit group that failed migration"},"group":{"$ref":"#/definitions/MigrationUnitGroup"},"percent_complete":{"readOnly":true,"type":"number","description":"Indicator of migration progress in percentage","title":"Indicator of migration progress in percentage"}}}]},"BgpNeighborAddressFamily":{"x-vmw-nsx-module":"Routing","required":["type"],"type":"object","properties":{"in_filter_ipprefixlist_id":{"type":"string","description":"Id of the IPPrefix List to be used for IN direction filter","title":"Id of the IPPrefix List to be used for IN direction filter"},"out_filter_routemap_id":{"type":"string","description":"Id of the RouteMap to be used for OUT direction filter","title":"Id of the RouteMap to be used for OUT direction filter"},"type":{"description":"Address family type","enum":["IPV4_UNICAST","VPNV4_UNICAST","IPV6_UNICAST","L2VPN_EVPN"],"type":"string"},"in_filter_routemap_id":{"type":"string","description":"Id of the RouteMap to be used for IN direction filter","title":"Id of the RouteMap to be used for IN direction filter"},"enabled":{"default":true,"type":"boolean","description":"Enable this address family","title":"Enable this address family"},"out_filter_ipprefixlist_id":{"type":"string","description":"Id of the IPPrefixList to be used for OUT direction filter","title":"Id of the IPPrefixList to be used for OUT direction filter"},"maximum_routes":{"format":"int64","minimum":0,"type":"integer","description":"Maximum number of routes supported on the address family","title":"Maximum number of routes supported on the address family"}}},"BridgeEndpointStatus":{"x-vmw-nsx-module":"AggSvcBridging","type":"object","properties":{"active_nodes":{"items":{"type":"string"},"readOnly":true,"type":"array","description":"The Ids of the transport nodes which actively serve the endpoint.","title":"The Ids of the transport nodes which actively serve the endpoint."},"last_update_timestamp":{"description":"Timestamp when the data was last updated; unset if data source has never updated the data.","format":"int64","readOnly":true,"type":"integer"},"endpoint_id":{"readOnly":true,"type":"string","description":"The id of the bridge endpoint","title":"The id of the bridge endpoint"}}},"MigrationFeedbackResponseList":{"description":"List of detailed feedback response for the migration tool.","title":"List of feedback reponse for Migration","required":["response_list"],"x-vmw-nsx-module":"Migration","type":"object","properties":{"response_list":{"items":{"$ref":"#/definitions/MigrationFeedbackResponse"},"readOnly":false,"type":"array","description":"List of feedback responses.","title":"List of feedback responses"}}},"NSGroupExpressionList":{"description":"List of NSGroupExpressions","title":"List of NSGroupExpressions","required":["members"],"x-vmw-nsx-module":"NSGroup","type":"object","properties":{"members":{"items":{"$ref":"#/definitions/NSGroupExpression"},"type":"array","description":"List of NSGroupExpressions to be passed to add and remove APIs\n","maxItems":500,"title":"List of NSGroupExpressions to be passed to add and remove APIs\n"}}},"Node":{"discriminator":"resource_type","x-vmw-nsx-module":"FabricNode","required":["resource_type"],"type":"object","properties":{"display_name":{"maxLength":255,"type":"string","description":"This field is deprecated. TransportNode field 'display_name' must be used instead. For HostNode, this field defaults to ID if not set. For EdgeNode and PublicCloudGatewayNode, this field is ignored if specified in request payload.","x-deprecated":true,"title":"Identifier to use when displaying entity in logs or GUI"},"description":{"maxLength":1024,"type":"string","description":"This field is deprecated. TransportNode field 'description' must be used instead. For EdgeNode and PublicCloudGatewayNode, this field is ignored if specified in request payload.","x-deprecated":true,"title":"Description of this resource"},"tags":{"description":"This field is deprecated. TransportNode field 'tags' must be used instead. For EdgeNode and PublicCloudGatewayNode, this field is ignored if specified in request payload.","title":"Opaque identifiers meaningful to the API user","items":{"$ref":"#/definitions/Tag"},"x-deprecated":true,"maxItems":30,"type":"array"},"discovered_ip_addresses":{"items":{"description":"IPv4 or IPv6 address","format":"ip","type":"string"},"readOnly":true,"type":"array","description":"Discovered IP Addresses of the fabric node, version 4 or 6","title":"Discovered IP Addresses of the fabric node, version 4 or 6"},"ip_addresses":{"items":{"description":"IPv4 or IPv6 address","format":"ip","type":"string"},"type":"array","description":"IP Addresses of the Node, version 4 or 6. This property is mandatory for all nodes except for\nautomatic deployment of edge virtual machine node. For automatic deployment, the ip address from\nmanagement_port_subnets property will be considered.\n","title":"IP Addresses of the Node, version 4 or 6"},"external_id":{"type":"string","description":"ID of the Node maintained on the Node and used to recognize the Node","title":"ID of the Node maintained on the Node and used to recognize the Node"},"fqdn":{"readOnly":true,"type":"string","description":"Fully qualified domain name of the fabric node","title":"Fully qualified domain name of the fabric node"},"resource_type":{"type":"string","description":"Fabric node type, for example 'HostNode', 'EdgeNode' or 'PublicCloudGatewayNode'","title":"Fabric node type, for example 'HostNode', 'EdgeNode' or 'PublicCloudGatewayNode'"},"id":{"type":"string","description":"Unique identifier of this resource.","title":"Unique identifier of this resource"}}},"DirectoryGroupListResults":{"x-vmw-nsx-module":"DirectoryService","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"DirectoryService","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/DirectoryGroup"},"type":"array","description":"Directory group list","title":"Directory group list"}}}]},"SshKeyBaseProperties":{"x-vmw-nsx-module":"MISSING_MODULE","required":["label"],"type":"object","properties":{"password":{"type":"string","description":"Current password for user (required for users root and admin)","title":"Current password for user (required for users root and admin)"},"label":{"type":"string","description":"SSH key label (used to identify the key)","title":"SSH key label (used to identify the key)"}}},"L2VPNSessionSummary":{"x-vmw-nsx-module":"L2VPNStatistics","type":"object","description":"List summary of L2VPN sessions.","properties":{"total_l2vpn_sessions":{"readOnly":true,"format":"int64","type":"integer","description":"Total L2VPN sessions configured.","title":"Total L2VPN sessions"},"established_l2vpn_sessions":{"readOnly":true,"format":"int64","type":"integer","description":"Number of established L2VPN sessions. L2VPN session is established when all the tunnels are up.","title":"Established L2VPN sessions"},"failed_l2vpn_sessions":{"readOnly":true,"format":"int64","type":"integer","description":"Number of failed L2VPN sessions. L2VPN session is failed when all the tunnels are down.","title":"Failed L2VPN sessions"}},"title":"L2VPN session status summary"},"StaticIpPoolSpec":{"x-vmw-nsx-module":"TransportNode","allOf":[{"$ref":"#/definitions/IpAssignmentSpec"},{"required":["ip_pool_id"],"x-vmw-nsx-module":"TransportNode","type":"object","properties":{"ip_pool_id":{"readOnly":false,"type":"string"}}}],"description":"IP assignment specification for Static IP Pool.","title":"IP assignment specification for Static IP Pool."},"SubjectPublicKeyHash":{"x-vmw-nsx-module":"CertificateManager","type":"object","properties":{"public_key_sha256_hashes":{"items":{"type":"string"},"type":"array","description":"List of SHA256 hashes of the Public Key of the revoked certificates with the specified subject.","title":"SHA256 hashes of Public Keys"},"subject":{"type":"string","description":"Subject Distinguished Name of the revoked certificates.","title":"Subject Distinguished Name (DN)"}}},"IpDiscoverySwitchingProfile":{"x-vmw-nsx-module":"IpDiscoverySwitchingProfile","allOf":[{"$ref":"#/definitions/BaseSwitchingProfile"},{"x-vmw-nsx-module":"IpDiscoverySwitchingProfile","type":"object","properties":{"arp_snooping_enabled":{"default":true,"readOnly":false,"type":"boolean","description":"Indicates whether ARP snooping is enabled","title":"Indicates whether ARP snooping is enabled"},"arp_bindings_limit":{"description":"Indicates the number of arp snooped IP addresses to be remembered per LogicalPort. Decreasing this value, will retain the latest bindings from the existing list of address bindings. Increasing this value will retain existing bindings and also learn any new address bindings discovered on the port until the new limit is reached. This limit only applies to IPv4 addresses and is independent of the nd_bindings_limit used for IPv6 snooping.","title":"Number of IP addresses to be snooped via ARP snooping","default":1,"format":"int32","maximum":256,"minimum":1,"type":"integer"},"dhcpv6_snooping_enabled":{"default":false,"readOnly":false,"type":"boolean","description":"This option is the IPv6 equivalent of DHCP snooping.","title":"Indicates if stateful DHCPv6 snooping is enabled"},"nd_snooping_enabled":{"default":false,"readOnly":false,"type":"boolean","description":"This option is the IPv6 equivalent of ARP snooping.","title":"Indicates if neighbor discovery snooping is enabled"},"vm_tools_v6_enabled":{"default":false,"readOnly":false,"type":"boolean","description":"This option is only supported on ESX where vm-tools is installed.","title":"Indicates whether fetching IPv6 addresses using vm-tools is enabled"},"dhcp_snooping_enabled":{"default":true,"readOnly":false,"type":"boolean","description":"Indicates whether DHCP snooping is enabled","title":"Indicates whether DHCP snooping is enabled"},"arp_nd_binding_timeout":{"description":"This property controls the ARP and ND cache timeout period.It\nis recommended that this property be greater than the ARP/ND\ncache timeout on the VM.\n","title":"ARP and ND cache timeout (in minutes)","default":10,"format":"int32","maximum":120,"readOnly":false,"minimum":5,"type":"integer"},"vm_tools_enabled":{"default":true,"readOnly":false,"type":"boolean","description":"This option is only supported on ESX where vm-tools is installed.","title":"Indicates whether fetching IP using vm-tools is enabled"},"trust_on_first_use_enabled":{"default":true,"readOnly":false,"type":"boolean","description":"ARP snooping being inherently susceptible to ARP spoofing,\nuses a turst-on-fisrt-use (TOFU) paradigm where only the first IP address\ndiscovered via ARP snooping is trusted. The remaining are ignored.\nIn order to allow for more flexibility, we allow the user to\nconfigure how many ARP snooped address bindings should be trusted\nfor the lifetime of the logical port. This is controlled by the\narp_bindings_limit property in the IP Discovery profile. We refer\nto this extension of TOFU as N-TOFU.\nHowever, if TOFU is disabled, then N ARP snooped IP addresses will\nbe trusted until they are timed out, where N is configured by\narp_bindings_limit.\n","title":"Controls whether trust-on-first-use should be enabled"},"nd_bindings_limit":{"description":"Indicates the number of neighbor-discovery snooped IP addresses to be remembered per LogicalPort. Decreasing this value, will retain the latest bindings from the existing list of address bindings. Increasing this value will retain existing bindings and also learn any new address bindings discovered on the port until the new limit is reached. This limit only applies to IPv6 addresses and is independent of the arp_bindings_limit used for IPv4 snooping.","title":"Number of IP addresses to be snooped via neighbor-discovery(ND) snooping","default":3,"format":"int32","maximum":15,"minimum":2,"type":"integer"},"duplicate_ip_detection":{"$ref":"#/definitions/DuplicateIPDetection"}}}]},"MacTableEntry":{"x-vmw-nsx-module":"AggSvcLogicalSwitch","required":["mac_address"],"type":"object","properties":{"vtep_mac_address":{"type":"string","description":"The virtual tunnel endpoint MAC address","title":"The virtual tunnel endpoint MAC address"},"rtep_group_id":{"format":"int64","type":"integer","description":"RTEP group id is applicable when the logical switch is stretched\nacross multiple sites. When rtep_group_id is set, mac_address\nrepresents remote mac_address.\n","title":"Remote tunnel endpoint(RTEP) group id"},"vtep_ip":{"description":"The virtual tunnel endpoint IP address","format":"ip","type":"string"},"vtep_group_id":{"format":"int64","type":"integer","description":"VTEP group id is applicable when the logical switch is stretched\nacross multiple sites. When vtep_group_id is set, mac_address\nrepresents remote mac_address.\n","title":"Virtual tunnel endpoint(VTEP) group id"},"mac_address":{"type":"string","description":"The MAC address","title":"The MAC address"}}},"IdfwComputeCollectionStatus":{"description":"compute collection ID and status connected to VC.","title":"IDFW compute collection ID and status.","required":["compute_collection_id"],"x-vmw-nsx-module":"IdentityFirewall","type":"object","properties":{"compute_collection_status":{"items":{"$ref":"#/definitions/IdfwComputeCollectionCondition"},"type":"array","description":"IDFW enabled compute collection status.","title":"Compute collection status."},"compute_collection_id":{"type":"string","description":"IDFW compute collection ID connected to VC.","title":"IDFW compute collection ID."}}},"MirrorDestination":{"discriminator":"resource_type","x-vmw-nsx-module":"PortMirroring","required":["resource_type"],"type":"object","properties":{"resource_type":{"description":"Resource types of mirror destination","enum":["LogicalPortMirrorDestination","PnicMirrorDestination","IPMirrorDestination"],"type":"string"}}},"RepoSyncStatusReport":{"x-vmw-nsx-module":"ClusterNodeVMDeployment","required":["status"],"type":"object","properties":{"status":{"enum":["NOT_STARTED","IN_PROGRESS","FAILED","SUCCESS"],"type":"string","description":"Status of the repo sync operation on the single nsx-manager\n","title":"Repository Synchronization Status"},"status_message":{"type":"string","description":"Describes the steps which repo sync operation is performing currently.\n","title":"Status message"},"failure_message":{"type":"string","description":"In case if repo sync fails due to some issue, an error message will be\nstored here.\n","title":"Error message for failure"},"failure_code":{"format":"int64","type":"integer","description":"In case of repo sync related failure, the code for the error will\nbe stored here.\n","title":"Error code for failure"}}},"ArpHeader":{"x-vmw-nsx-module":"Traceflow","required":["op_code","dst_ip"],"type":"object","properties":{"op_code":{"default":"ARP_REQUEST","enum":["ARP_REQUEST","ARP_REPLY"],"type":"string","description":"This field specifies the nature of the Arp message being sent.","title":"Arp message type"},"src_ip":{"description":"This field specifies the IP address of the sender. If omitted, the src_ip is set to 0.0.0.0.","format":"ipv4","type":"string"},"dst_ip":{"description":"The destination IP address","format":"ipv4","type":"string"}}},"LbVirtualServerStatisticsListResult":{"x-vmw-nsx-module":"AggSvcLb","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"AggSvcLb","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/LbVirtualServerStatistics"},"type":"array","description":"paginated statistics list of virtual servers","title":"paginated statistics list of virtual servers"}}}]},"LbHttpRequestUriArgumentsCondition":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/LbRuleCondition"},{"required":["uri_arguments"],"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"uri_arguments":{"type":"string","description":"URI arguments, aka query string of URI.\n","title":"URI arguments"},"match_type":{"description":"Match type of URI arguments","default":"REGEX","enum":["STARTS_WITH","ENDS_WITH","EQUALS","CONTAINS","REGEX"],"type":"string"},"case_sensitive":{"default":true,"type":"boolean","description":"If true, case is significant when comparing URI arguments.\n","title":"A case sensitive flag for URI arguments comparing"}}}],"description":"This condition is used to match URI arguments aka query string of Http\nrequest messages, for example, in URI http://exaple.com?foo=1&bar=2, the\n\"foo=1&bar=2\" is the query string containing URI arguments. In an URI\nscheme, query string is indicated by the first question mark (\"?\")\ncharacter and terminated by a number sign (\"#\") character or by the end of\nthe URI.\nThe uri_arguments field can be specified as a regular expression(Set\nmatch_type to REGEX). For example, \"foo=(?<x>\\d+)\". It matches HTTP\nrequests whose URI arguments containing \"foo\", the value of foo contains\nonly digits. And the value of foo is captured as $x which can be used in\nLbRuleAction fields which support variables.\n","title":"Condition to match URI arguments of HTTP requests"},"AgentStatus":{"x-vmw-nsx-module":"Heatmap","type":"object","properties":{"status":{"enum":["UP","DOWN","UNKNOWN"],"type":"string","description":"Agent status","title":"Agent status"},"name":{"enum":["NSX_AGENT","NSX_OPSAGENT","NSX_CFGAGENT","NSX_NESTDB"],"type":"string","description":"Agent name","title":"Agent name"}}},"Ipv6Header":{"x-vmw-nsx-module":"Traceflow","type":"object","properties":{"src_ip":{"description":"The source ip address.","format":"ipv6","type":"string"},"dst_ip":{"description":"The destination ip address.","format":"ipv6","type":"string"},"next_header":{"description":"Identifies the type of header immediately following the IPv6 header.","title":"Identifies the type of header immediately following the IPv6 header.","default":58,"format":"int64","maximum":255,"minimum":0,"type":"integer"},"hop_limit":{"description":"Decremented by 1 by each node that forwards the packets. The packet is discarded if Hop Limit is decremented to zero.","title":"hop limit","default":64,"format":"int64","maximum":255,"minimum":0,"type":"integer"}}},"NodeLogPropertiesListResult":{"x-vmw-nsx-module":"MISSING_MODULE","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/NodeLogProperties"},"type":"array","description":"Node log property results","title":"Node log property results"}}}],"description":"Node log property query results","title":"Node log property query results"},"InterfaceNeighborProperties":{"x-vmw-nsx-module":"Lldp","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"Lldp","type":"object","properties":{"ifindex":{"readOnly":true,"format":"int64","type":"integer","description":"Interface index","title":"Interface index"},"neighbors":{"description":"Neighbor properties","title":"Neighbor properties","items":{"$ref":"#/definitions/NeighborProperties"},"readOnly":true,"uniqueItems":true,"type":"array"},"mac":{"readOnly":true,"type":"string","description":"Interface MAC address","title":"Interface MAC address"},"name":{"readOnly":true,"type":"string","description":"Interface Name","title":"Interface Name"}}}],"description":"Interface neighbor properties","title":"Interface neighbor properties"},"ServiceInsertionSectionListResult":{"x-vmw-nsx-module":"ServiceInsertionRules","allOf":[{"$ref":"#/definitions/DSSectionListResult"},{"x-vmw-nsx-module":"ServiceInsertionRules","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/ServiceInsertionSection"},"readOnly":true,"type":"array","description":"List of the ServiceInsertion sections. The list has to be homogeneous.","title":"Section list"}}}],"description":"List of ServiceInsertion Sections.","title":"ServiceInsertion Section List"},"CsrList":{"x-vmw-nsx-module":"CertificateManager","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"CertificateManager","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/Csr"},"readOnly":false,"type":"array","description":"CSR list."}}}],"description":"Csr queries result","title":"Csr queries result"},"VMDeploymentProgressState":{"x-vmw-nsx-module":"HostPrepServiceFabric","type":"object","description":"Deployment progress state of node VM. This Object contains name of current deployment step and overall progress percentage.","properties":{"progress":{"readOnly":true,"format":"int64","type":"integer","description":"Overall progress percentage of deployment completed","title":"Progress percentage"},"current_step_title":{"readOnly":true,"type":"string","description":"Name of the current running step of deployment","title":"Name of the current step"}},"title":"Deployment progress of node VM"},"TraceflowObservationCounters":{"x-vmw-nsx-module":"Traceflow","type":"object","properties":{"forwarded_count":{"readOnly":true,"format":"int64","type":"integer","description":"Total number of forwarded observations for this traceflow round.","title":"Forwarded observation count"},"dropped_count":{"readOnly":true,"format":"int64","type":"integer","description":"Total number of dropped observations for this round.","title":"Dropped observation count"},"delivered_count":{"readOnly":true,"format":"int64","type":"integer","description":"Total number of delivered observations for this traceflow round.","title":"Delivered observation count"},"received_count":{"readOnly":true,"format":"int64","type":"integer","description":"Total number of received observations for this traceflow round.","title":"Received observation count"}}},"SshServiceProperties":{"description":"SSH Service properties","title":"SSH Service properties","required":["start_on_boot"],"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"root_login":{"type":"boolean","description":"Permit SSH Root login","title":"Permit SSH Root login"},"start_on_boot":{"type":"boolean","description":"Start service when system boots","title":"Start service when system boots"}}},"StubStatus":{"x-vmw-nsx-module":"SiteManagerModule","required":["connection_up"],"type":"object","properties":{"connection_up":{"type":"boolean","description":"Is stub up","title":"Is stub up"},"address":{"type":"string","description":"IP/FQDN of the node","title":"IP/FQDN of the node"}}},"ComponentMigrationStatus":{"x-vmw-nsx-module":"Migration","type":"object","properties":{"status":{"readOnly":true,"enum":["SUCCESS","FAILED","IN_PROGRESS","NOT_STARTED","PAUSING","PAUSED"],"type":"string","description":"Migration status of component","title":"Migration status of component"},"percent_complete":{"readOnly":true,"type":"number","description":"Indicator of migration progress in percentage","title":"Indicator of migration progress in percentage"},"can_skip":{"readOnly":true,"type":"boolean","description":"Can the migration of the remaining units in this component be skipped","title":"Can the migration of the remaining units in this component be skipped"},"details":{"readOnly":true,"type":"string","description":"Details about the migration status","title":"Details about the migration status"},"component_type":{"readOnly":true,"type":"string","description":"Component type for the migration status","title":"Component type for the migration status"}}},"LogicalRouterRouteEntry":{"x-vmw-nsx-module":"AggSvcLogicalRouter","required":["route_type","network"],"type":"object","properties":{"lr_component_id":{"type":"string","description":"Logical router component(Service Router/Distributed Router) id","title":"Logical router component(Service Router/Distributed Router) id"},"next_hop":{"description":"The IP address of the next hop","format":"ip","type":"string"},"lr_component_type":{"type":"string","description":"Logical router component(Service Router/Distributed Router) type","title":"Logical router component(Service Router/Distributed Router) type"},"network":{"description":"CIDR network address","format":"ip-cidr-block","type":"string"},"route_type":{"type":"string","description":"Route type (USER, CONNECTED, NSX_INTERNAL,..)","title":"Route type (USER, CONNECTED, NSX_INTERNAL,..)"},"logical_router_port_id":{"type":"string","description":"The id of the logical router port which is used as the next hop","title":"The id of the logical router port which is used as the next hop"},"admin_distance":{"format":"int64","type":"integer","description":"The admin distance of the next hop","title":"The admin distance of the next hop"}}},"IpInfo":{"x-vmw-nsx-module":"LiveTrace","type":"object","description":"Only support IP address or subnet. Its type can be of\nIPv4 or IPv6. It will be converted to subnet when netmask\nis specified(e.g., 192.168.1.3/24 => 192.168.1.0/24,\n2008:12:12:12::2/64 => 2008:12:12:12::/64).\n","properties":{"src_ip":{"description":"The source IP address or subnet","format":"address-or-block-or-range","type":"string"},"dst_ip":{"description":"The destination IP address or subnet","format":"address-or-block-or-range","type":"string"}}},"ServiceAttachmentListResult":{"x-vmw-nsx-module":"ServiceInsertion","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"ServiceInsertion","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/ServiceAttachment"},"readOnly":true,"type":"array","description":"List of the Service Attachments.","title":"Service-Attachment list"}}}],"description":"List of Service Attachments.","title":"Service Attachment List"},"ContainerClusterSummary":{"x-vmw-nsx-module":"TnContainerStatus","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"TnContainerStatus","required":["cluster_name","status"],"type":"object","properties":{"cluster_name":{"type":"string","description":"Display the container cluster name","title":"Container cluster name"},"status":{"description":"Display the container cluster status.","enum":["UNKNOWN","HEALTHY","DOWN","DEGRADED"],"type":"string"},"type":{"description":"Container cluster type.","enum":["PAS","PKS","Kubernetes","Openshift","WCP","Other"],"type":"string"},"detail":{"readOnly":true,"type":"string","description":"Detail information on status.","title":"Detail information on status"},"cluster_id":{"readOnly":true,"type":"string","description":"Identifier of the container cluster.","title":"Identifier of the container cluster"}}}]},"RecommendedFeaturePermissionListResult":{"x-vmw-nsx-module":"AAA","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"AAA","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/RecommendedFeaturePermission"},"type":"array","description":"List results","title":"List results"}}}]},"NvdsUpgradeHostState":{"x-vmw-nsx-module":"NvdsUpgradeReadinessCheck","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"NvdsUpgradeReadinessCheck","type":"object","properties":{"state_details":{"items":{"type":"string"},"readOnly":true,"type":"array","description":"Details of the N-VDS upgrade state on the host","title":"Details of the N-VDS upgrade state on the host"},"host":{"readOnly":true,"type":"string","description":"TransportNode identifier","title":"TransportNode identifier"},"upgrade_stage":{"readOnly":true,"type":"string","description":"This field returns current stage of Migration task. Here is a sequence\nof stages the task cycles through,\nTN_MIGRATION_TASK_IN_QUEUE\nRETRIEVE_SAVED_CONFIG,\nTN_VALIDATE,\nVMS_RETRIVAL,\nVMS_UNREGISTRATION,\nTN_STATELESS_WAIT_FOR_HP,\nDETACH_TNP,\nTNP_WAIT,\nTN_SEND_HS_MIGRATION_MSG,\nTN_ADD_HOST_TO_VDS,\nTN_UPDATE,\nTN_UPDATE_WAIT,\nTN_DELETE,\nTN_DELETE_WAIT,\nFN_DELETE_WAIT,\nTN_RECONFIG_HOST,\nTN_CREATE,\nTN_CREATE_WAIT,\nUPDATE_TNP_AND_APPLY,\nTN_EXIT_MM,\nVMS_REGISTRATION,\nVMS_REGISTRATION_WAIT,\nTN_MIGRATION_COMPLETED\nDepending on the type of host (stateful, stateless, Sddc, etc.) migration\ntask may not cycle through all stages but in will follow above sequence.\nIf stage is TN_MIGRATION_COMPLETED refer to field overall_state for SUCCESS\nor UPGRADE_FAILURE and state_details for details on same.\n","title":"Current migration task stage"},"overall_state":{"readOnly":true,"enum":["UPGRADE_READY","UPGRADE_PROCESSING","UPGRADE_QUEUED","UPGRADE_IN_PROGRESS","UPGRADE_FAILED","SUCCESS"],"type":"string","description":"Overall state of N-VDSes on the TransportNodes","title":"Overall state of N-VDSes on the TransportNodes"},"dn_ext_id":{"readOnly":true,"type":"string","description":"DiscoveredNode identifier","title":"DiscoveredNode identifier"},"ip_address":{"readOnly":true,"type":"string","description":"TransportNode ip address","title":"TransportNode ip address"}}}],"description":"Individual host upgrade state","title":"Individual host upgrade state"},"ComponentUpgradeChecksInfoListResult":{"x-vmw-nsx-module":"Upgrade","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"Upgrade","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/ComponentUpgradeChecksInfo"},"type":"array","description":"Collection of info of pre/post-upgrade checks for components","title":"Collection of info of pre/post-upgrade checks for components"}}}]},"UsernamePasswordLoginCredential":{"x-vmw-nsx-module":"Types","allOf":[{"$ref":"#/definitions/LoginCredential"},{"x-vmw-nsx-module":"Types","type":"object","properties":{"username":{"type":"string","description":"The username for login","title":"The username for login"},"password":{"type":"string","description":"The authentication password for login","title":"The authentication password for login"},"thumbprint":{"type":"string","description":"Thumbprint of the login server","title":"Thumbprint of the login server"}}}],"description":"A login credential specifying a username and password","title":"A login credential specifying a username and password"},"License":{"x-vmw-nsx-module":"License","description":"license properties","allOf":[{"$ref":"#/definitions/Resource"},{"x-vmw-nsx-module":"License","type":"object","properties":{"features":{"readOnly":true,"type":"string","description":"semicolon delimited feature list","title":"semicolon delimited feature list"},"description":{"readOnly":true,"type":"string","description":"license edition","title":"license edition"},"product_version":{"readOnly":true,"type":"string","description":"product version","title":"product version"},"expiry":{"description":"date that license expires","format":"int64","readOnly":true,"type":"integer"},"is_eval":{"readOnly":true,"type":"boolean","description":"true for evalution license","title":"true for evalution license"},"is_mh":{"readOnly":true,"type":"boolean","description":"multi-hypervisor support","title":"multi-hypervisor support"},"license_key":{"type":"string","description":"license key","title":"license key"},"is_expired":{"readOnly":true,"type":"boolean","description":"whether the license has expired","title":"whether the license has expired"},"product_name":{"readOnly":true,"type":"string","description":"product name","title":"product name"},"capacity_type":{"readOnly":true,"enum":["VM","CPU","USER","CORE","HOST"],"type":"string","description":"License metrics specifying the capacity type of license key.\nTypes are:\n- VM\n- CPU\n- USER(Concurrent User)\n- CORE\n- HOST\n","title":"license metric"},"quantity":{"readOnly":true,"format":"int64","type":"integer","description":"license capacity; 0 for unlimited","title":"license capacity; 0 for unlimited"}}}]},"HttpServiceProperties":{"x-vmw-nsx-module":"MISSING_MODULE","type":"object","description":"HTTP Service properties","properties":{"global_api_concurrency_limit":{"description":"The maximum number of concurrent API requests that will be serviced. If the number of API requests being processed exceeds this limit, new API requests will be refused and a 503 Service Unavailable response will be returned to the client. To disable API concurrency limiting, set this value to 0.","format":"int64","default":100,"title":"Global API rate limit in calls","minimum":0,"type":"integer"},"certificate":{"$ref":"#/definitions/Certificate"},"basic_authentication_enabled":{"default":true,"type":"boolean","description":"Identifies whether basic authentication is enabled or disabled in API calls.","title":"Enable or disable basic authentication"},"cookie_based_authentication_enabled":{"default":true,"type":"boolean","description":"Identifies whether cookie-based authentication is enabled or disabled in API calls. When cookie-based authentication is disabled, new sessions cannot be created via /api/session/create.","title":"Enable or disable cookie-based authentication"},"cipher_suites":{"minItems":1,"items":{"$ref":"#/definitions/CipherSuite"},"type":"array","description":"Cipher suites used to secure contents of connection","title":"Cipher suites used to secure contents of connection"},"redirect_host":{"description":"Host name or IP address to use for redirect location headers, or empty string to derive from current request","default":"","pattern":"/^(?=.{1,255}$)[0-9A-Za-z](?:(?:[0-9A-Za-z]|-){0,61}[0-9A-Za-z])?(?:\\.[0-9A-Za-z](?:(?:[0-9A-Za-z]|-){0,61}[0-9A-Za-z])?)*\\.?$|^$/","type":"string"},"session_timeout":{"description":"NSX session inactivity timeout, set to 0 to configure no timeout","format":"int64","title":"NSX session inactivity timeout, set to 0 to configure no timeout","maximum":2147483647,"minimum":0,"type":"integer"},"client_api_rate_limit":{"description":"The maximum number of API requests that will be serviced per second for a given authenticated client. If more API requests are received than can be serviced, a 429 Too Many Requests HTTP response will be returned. To disable API rate limiting, set this value to 0.","format":"int64","default":100,"title":"Client API rate limit in calls per second","minimum":0,"type":"integer"},"client_api_concurrency_limit":{"description":"The maximum number of concurrent API requests that will be serviced for a given authenticated client. If the number of API requests being processed exceeds this limit, new API requests will be refused and a 503 Service Unavailable response will be returned to the client. To disable API concurrency limiting, set this value to 0.","format":"int64","default":40,"title":"Client API rate limit in calls","minimum":0,"type":"integer"},"protocol_versions":{"minItems":1,"items":{"$ref":"#/definitions/ProtocolVersion"},"type":"array","description":"TLS protocol versions","title":"TLS protocol versions"},"connection_timeout":{"description":"NSX connection timeout, set to 0 to configure no timeout","format":"int64","title":"NSX connection timeout, set to 0 to configure no timeout","maximum":2147483647,"minimum":0,"type":"integer"},"logging_level":{"default":"INFO","enum":["OFF","FATAL","ERROR","WARN","INFO","DEBUG","TRACE"],"type":"string","description":"Service logging level","title":"Service logging level"}},"title":"HTTP Service properties"},"CentralNodeConfigProfileListResult":{"x-vmw-nsx-module":"CentralConfig","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"CentralConfig","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/CentralNodeConfigProfile"},"type":"array","description":"Central Node Config profiles","title":"Central Node Config profiles"}}}],"description":"Paged collection of Central Node Config profiles.","title":"List of Central Node Config profiles"},"MgmtConnStatus":{"x-vmw-nsx-module":"ClusterManagement","type":"object","properties":{"connectivity_status":{"readOnly":true,"enum":["CONNECTED","DISCONNECTED","UNKNOWN"],"type":"string","description":"Indicates the controller node's MP channel connectivity status","title":"Indicates the controller node's MP channel connectivity status"}}},"LbPersistenceProfileListResult":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"LoadBalancer","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/LbPersistenceProfile"},"type":"array","description":"paginated list of load balancer persistence profiles","title":"paginated list of load balancer persistence profiles"}}}]},"ApplianceProcessListResult":{"x-vmw-nsx-module":"ShaApplianceMonitor","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"ShaApplianceMonitor","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/ApplianceProcessData"},"type":"array","description":"Display the appliance process list.","title":"Appliance Process List"}}}],"description":"List of process data","title":"List of process data"},"View":{"x-vmw-nsx-module":"NsxDashboard","allOf":[{"$ref":"#/definitions/ManagedResource"},{"required":["widgets","display_name"],"x-vmw-nsx-module":"NsxDashboard","type":"object","properties":{"include_roles":{"maxLength":1024,"type":"string","description":"Comma separated list of roles to which the shared view is visible. Allows user to specify the visibility of a shared view to the specified roles. User defined roles can also be specified in the list. The roles can be obtained via GET /api/v1/aaa/roles. Please visit API documentation for details about roles.","title":"Roles to which the shared view is visible"},"display_name":{"maxLength":255,"type":"string","description":"Title of the widget.","title":"Widget Title"},"exclude_roles":{"maxLength":1024,"type":"string","description":"Comma separated list of roles to which the shared view is not visible. Allows user to prevent the visibility of a shared view to the specified roles. User defined roles can also be specified in the list. The roles can be obtained via GET /api/v1/aaa/roles. Please visit API documentation for details about roles. If include_roles is specified then exclude_roles cannot be specified.","title":"Roles to which the shared view is not visible"},"weight":{"default":10000,"format":"int32","type":"integer","description":"Determines placement of view relative to other views. The lower the weight, the higher it is in the placement order.","title":"Weightage or placement of the view"},"widgets":{"minItems":0,"items":{"$ref":"#/definitions/WidgetItem"},"type":"array","description":"Array of widgets that are part of the view.","title":"Widgets"},"shared":{"default":false,"type":"boolean","description":"Defaults to false. Set to true to publish the view to other users. The widgets of a shared view are visible to other users.","title":"Share the view with other users"}}}],"description":"Describes the configuration of a view to be displayed on the dashboard.","title":"Dashboard View"},"ProgressItem":{"x-vmw-nsx-module":"SiteManagerModule","required":["name","description"],"type":"object","properties":{"parts":{"items":{"$ref":"#/definitions/ProgressItemPart"},"type":"array","description":"Finer details, usually there is only one part","title":"Finer details, usually there is only one part"},"name":{"type":"string","description":"Name of the item","title":"Name of the item"},"description":{"type":"string","description":"Item description","title":"Item description"}}},"LbHttpRequestCookieCondition":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/LbRuleCondition"},{"required":["cookie_name","cookie_value"],"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"match_type":{"description":"Match type of cookie value","default":"REGEX","enum":["STARTS_WITH","ENDS_WITH","EQUALS","CONTAINS","REGEX"],"type":"string"},"cookie_name":{"type":"string","description":"Name of cookie","title":"Name of cookie"},"cookie_value":{"type":"string","description":"Value of cookie","title":"Value of cookie"},"case_sensitive":{"default":true,"type":"boolean","description":"If true, case is significant when comparing cookie value.\n","title":"A case sensitive flag for cookie value comparing"}}}],"description":"This condition is used to match HTTP request messages by cookie which is a\nspecific type of HTTP header. The match_type and case_sensitive define how\nto compare cookie value.\n","title":"Condition to match HTTP request cookie"},"IPSecVPNTrafficCounters":{"x-vmw-nsx-module":"VPNStatistics","type":"object","description":"Traffic counters for IPSec VPN session.","properties":{"packets_out":{"readOnly":true,"format":"int64","type":"integer","description":"Total number of packets sent.","title":"Packets out"},"dropped_packets_out":{"readOnly":true,"format":"int64","type":"integer","description":"Total number of outgoing packets dropped on outbound security association.","title":"Dropped outgoing packets"},"bytes_in":{"readOnly":true,"format":"int64","type":"integer","description":"Total number of bytes recevied.","title":"Bytes in"},"bytes_out":{"readOnly":true,"format":"int64","type":"integer","description":"Total number of bytes sent.","title":"Bytes out"},"dropped_packets_in":{"readOnly":true,"format":"int64","type":"integer","description":"Total number of incoming packets dropped on inbound security association.","title":"Dropped incoming packets"},"packets_in":{"readOnly":true,"format":"int64","type":"integer","description":"Total number of packets received.","title":"Packets in"}},"title":"IPSec VPN traffic counters"},"PolicyTraceflowObservationForwardedLogical":{"x-vmw-nsx-module":"PolicyConnectivity","allOf":[{"$ref":"#/definitions/TraceflowObservationForwardedLogical"},{"x-vmw-nsx-module":"PolicyConnectivity","type":"object","properties":{"nat_rule_path":{"readOnly":true,"type":"string","description":"The path of the NAT rule that was applied to forward the traceflow packet","title":"Network Address Translation Rule Path"},"jumpto_rule_path":{"readOnly":true,"type":"string","description":"The path of the jump-to rule that was applied to the traceflow packet","title":"Jump-to Rule Path"},"component_path":{"readOnly":true,"type":"string","description":"The path of the component that forwarded the traceflow packet","title":"The path of the component that forwarded the traceflow packet"},"segment_port_path":{"readOnly":true,"type":"string","description":"The path of the segment port or router port through which the traceflow packet was forwarded","title":"The path of the segment port or router port through which the traceflow packet was forwarded"},"l2_rule_path":{"readOnly":true,"type":"string","description":"The path of the l2 rule that was applied to the traceflow packet","title":"L2 Rule Path"},"acl_rule_path":{"readOnly":true,"type":"string","description":"The path of the ACL rule that was applied to forward the traceflow packet","title":"Access Control List Rule Path"},"dst_component_path":{"readOnly":true,"type":"string","description":"The path of the destination component to which the traceflow packet was forwarded","title":"The path of the destination component to which the traceflow packet was forwarded"}}}]},"ResourceLink":{"x-vmw-nsx-module":"Common","type":"object","description":"A link to a related resource","properties":{"action":{"readOnly":true,"type":"string","description":"Optional action","title":"Optional action"},"href":{"readOnly":true,"type":"string","description":"Link to resource","title":"Link to resource"},"rel":{"readOnly":true,"type":"string","description":"Custom relation type (follows RFC 5988 where appropriate definitions exist)","title":"Link relation type"}},"title":"A link to a related resource"},"IPSecVPNTunnelProfileListResult":{"x-vmw-nsx-module":"IPSecVPN","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"IPSecVPN","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/IPSecVPNTunnelProfile"},"type":"array","description":"IPSec Tunnel Profile list results","title":"IPSec Tunnel Profile list results"}}}],"description":"List all the tunnel profiles.","title":"List tunnel profiles"},"NewRole":{"description":"New Role","title":"New Role","required":["new_role_name","new_role_id"],"x-vmw-nsx-module":"AAA","type":"object","properties":{"new_role_name":{"type":"string","description":"New role name","title":"New role name"},"new_role_description":{"type":"string","description":"New role description","title":"New role description"},"new_role_id":{"type":"string","description":"New role id","title":"New role id"}}},"NSSupportedAttributesListResult":{"x-vmw-nsx-module":"NSProfile","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"NSProfile","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/NSSupportedAttributes"},"readOnly":true,"type":"array","description":"Paged collection of NSSupportedAttributes","title":"Paged collection of NSSupportedAttributes"}}}],"description":"NSSupportedAttributes for supported attributes and sub-attributes","title":"NSSupportedAttributes for supported attributes and sub-attributes"},"L2ForwarderStatus":{"x-vmw-nsx-module":"AggSvcL2Forwarder","type":"object","properties":{"last_update_timestamp":{"description":"Timestamp when the service router status was last updated.\n","format":"int64","readOnly":true,"type":"integer"},"logical_switch_id":{"readOnly":true,"type":"string","description":"Logical switch id on which the L2 forwarder is created.\n","title":"Logical switch id of L2 forwarder"},"status_per_node":{"items":{"$ref":"#/definitions/L2ForwarderStatusPerNode"},"readOnly":true,"type":"array","description":"L2 forwarder status per node.","title":"L2 forwarder status per node"}}},"LogicalPortAttachmentState":{"x-vmw-nsx-module":"LogicalPort","type":"object","description":"VIF attachment state of a logical port","properties":{"state":{"readOnly":true,"enum":["FREE","ATTACHED","ATTACHED_PENDING_CONF","ATTACHED_IN_MOTION","DETACHED"],"type":"string","description":"A logicalPort must be in one of following state.\nFREE - If there are no active attachers. The LogicalPort may or\nmay not have an attachment ID configured on it. This state is\napplicable only to LogialPort of static type.\nATTACHED - LogicalPort has exactly one active attacher and no\nfurther configuration is pending.\nATTACHED_PENDING_CONF - LogicalPort has exactly one attacher,\nhowever it may not have been configured completely. Additional\nconfiguration will be provided by other nsx components.\nATTACHED_IN_MOTION - LogicalPort has multiple active attachers.\nThis state represents a scenario where VM is moving from one\nlocation (host or storage) to another (e.g. vmotion, vSphere HA)\nDETACHED - A temporary state after all LogialPort attachers have\nbeen detached. This state is applicable only to LogicalPort of\nephemeral type and the LogicalPort will soon be deleted.\n","title":"State of the VIF attached to LogicalPort"},"attachers":{"items":{"$ref":"#/definitions/PortAttacher"},"readOnly":true,"type":"array","description":"VM or vmknic entities that are attached to the LogicalPort","title":"VM or vmknic entities that are attached to the LogicalPort"},"id":{"readOnly":true,"type":"string","description":"VIF ID","title":"VIF ID"}},"title":"VIF attachment state of a logical port"},"NodeInterfacePropertiesListResult":{"x-vmw-nsx-module":"ApplianceStats","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"ApplianceStats","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/NodeInterfaceProperties"},"type":"array","description":"Node interface property results","title":"Node interface property results"}}}],"description":"Node network interface properties list results","title":"Node network interface properties list results"},"TcpMssClamping":{"x-vmw-nsx-module":"IPSecVPN","type":"object","description":"Tcp Mss Clamping Direction and value","properties":{"max_segment_size":{"description":"It defines the maximum amount of data that a host is willing to accept in a single TCP segment. This field is set in TCP header during connection establishment. To avoid packet fragmentation, you can set this field depending on uplink MTU and VPN overhead. This is optional field and in case it is left unconfigured, best possible MSS value will be calculated based on effective mtu of uplink interface. Supported MSS range is 108 to 8902.","format":"int64","title":"Maximum Segment Size value","maximum":8902,"minimum":108,"type":"integer"},"direction":{"default":"NONE","enum":["NONE","INBOUND_CONNECTION","OUTBOUND_CONNECTION","BOTH"],"type":"string","description":"Specifies the traffic direction for which to apply MSS Clamping.","title":"MSS Clamping direction"}},"title":"Tcp Mss Clamping Object"},"ManagementClusterNodeStatus":{"x-vmw-nsx-module":"ClusterManagement","type":"object","properties":{"mgmt_cluster_status":{"description":"Status of this node's connection to the management cluster","enum":["CONNECTED","DISCONNECTED","UNKNOWN"],"readOnly":true,"type":"string"}}},"LbHttpRequestMethodCondition":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/LbRuleCondition"},{"required":["method"],"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"method":{"description":"Type of HTTP request method","enum":["GET","OPTIONS","POST","HEAD","PUT"],"type":"string"}}}],"description":"This condition is used to match method of HTTP requests. If the method of an\nHTTP request is same as the method specified in this condition, the HTTP\nrequest match this condition. For example, if the method field is set to\nGET in this condition, any HTTP request with GET method matches the\ncondition.\n","title":"Condition to match method of HTTP request messages"},"RoleBindingListResult":{"x-vmw-nsx-module":"AAA","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"AAA","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/RoleBinding"},"type":"array","description":"List results","title":"List results"}}}]},"L2VpnTunnelEncapsulation":{"x-vmw-nsx-module":"L2VPN","type":"object","description":"L2VPN tunnel encapsulation config","properties":{"local_endpoint_ip":{"description":"IP Address of the tunnel port. For hub, the IP is allocated from L2VpnService logical_tap_ip_pool. All sessions on same L2VpnService get the same local_endpoint_ip. For spoke, the IP must be provided.","format":"ipv4","type":"string"},"protocol":{"default":"GRE","enum":["GRE"],"type":"string","description":"Encapsulation protocol used by the tunnel","title":"Encapsulation protocol"},"peer_endpoint_ip":{"description":"IP Address of the peer tunnel port. For hub, the IP is allocated from L2VpnService logical_tap_ip_pool. For spoke, the IP must be provided.","format":"ipv4","type":"string"}},"title":"L2VPN tunnel encapsulation config"},"InventoryConfig":{"x-vmw-nsx-module":"Inventory","required":["compute_managers_soft_limit"],"type":"object","properties":{"compute_managers_soft_limit":{"readOnly":false,"format":"int32","type":"integer","description":"Soft limit on number of compute managers, which can be added, beyond which,\naddition of compute managers will result in warning getting logged\n","title":"Soft limit on number of compute managers"}}},"SwitchingProfileStatus":{"x-vmw-nsx-module":"BaseSwitchingProfile","type":"object","properties":{"num_logical_ports":{"readOnly":true,"format":"int64","type":"integer","description":"Number of logical ports using a switching profile","title":"Number of logical ports using a switching profile"},"switching_profile_id":{"type":"string","description":"Identifier for the switching profile","title":"Identifier for the switching profile"},"num_logical_switches":{"readOnly":true,"format":"int64","type":"integer","description":"Number of logical switches using a switching profile","title":"Number of logical switches using a switching profile"}}},"TriggerUcUpgradeParameters":{"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"product_version":{"type":"string","description":"Target upgrade coordinator version.","title":"Target upgrade coordinator version."}}},"LbStatisticsCounter":{"x-vmw-nsx-module":"AggSvcLb","required":["bytes_out","max_sessions","total_sessions","bytes_in","current_sessions"],"type":"object","properties":{"source_ip_persistence_entry_size":{"format":"int64","type":"integer","description":"Number of source IP persistence entries","title":"Number of source IP persistence entries"},"packets_out":{"format":"int64","type":"integer","description":"Number of packets out","title":"Number of packets out"},"dropped_packets_by_access_list":{"format":"int64","type":"integer","description":"The total number of dropped TCP SYN or UDP packets by access list\ncontrol.\n","title":"The total number of dropped packets by access list control"},"bytes_out_rate":{"type":"number","description":"The average number of outbound bytes per second, the number is\naveraged over the last 5 one-second intervals.\n","title":"The average number of outbound bytes per second, the number is\naveraged over the last 5 one-second intervals.\n"},"total_sessions":{"format":"int64","type":"integer","description":"Number of total sessions","title":"Number of total sessions"},"http_request_rate":{"type":"number","description":"The average number of http requests per second, the number is\naveraged over the last 5 one-second intervals.\n","title":"The average number of http requests per second, the number is\naveraged over the last 5 one-second intervals.\n"},"bytes_out":{"format":"int64","type":"integer","description":"Number of bytes out","title":"Number of bytes out"},"packets_in_rate":{"type":"number","description":"The average number of inbound packets per second, the number is\naveraged over the last 5 one-second intervals.\n","title":"The average number of inbound packets per second, the number is\naveraged over the last 5 one-second intervals.\n"},"bytes_in_rate":{"type":"number","description":"The average number of inbound bytes per second, the number is\naveraged over the last 5 one-second intervals.\n","title":"The average number of inbound bytes per second, the number is\naveraged over the last 5 one-second intervals.\n"},"current_sessions":{"format":"int64","type":"integer","description":"Number of current sessions","title":"Number of current sessions"},"max_sessions":{"format":"int64","type":"integer","description":"Number of maximum sessions","title":"Number of maximum sessions"},"packets_out_rate":{"type":"number","description":"The average number of outbound packets per second, the number is\naveraged over the last 5 one-second intervals.\n","title":"The average number of outbound packets per second, the number is\naveraged over the last 5 one-second intervals.\n"},"http_requests":{"format":"int64","type":"integer","description":"The total number of http requests.","title":"The total number of http requests."},"bytes_in":{"format":"int64","type":"integer","description":"Number of bytes in","title":"Number of bytes in"},"current_session_rate":{"type":"number","description":"The average number of current sessions per second, the number is\naveraged over the last 5 one-second intervals.\n","title":"The average number of current sessions per second, the number is\naveraged over the last 5 one-second intervals.\n"},"dropped_sessions_by_lbrule_action":{"format":"int64","type":"integer","description":"The total number of dropped sessions by LB rule action.\n","title":"The total number of dropped sessions by LB rule action"},"packets_in":{"format":"int64","type":"integer","description":"Number of packets in","title":"Number of packets in"}}},"DSSectionListResult":{"x-vmw-nsx-module":"DistributedServices","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"DistributedServices","type":"object"}]},"LbSnatIpPool":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/LbSnatTranslation"},{"x-vmw-nsx-module":"LoadBalancer","required":["ip_addresses"],"type":"object","properties":{"ip_addresses":{"items":{"$ref":"#/definitions/LbSnatIpElement"},"type":"array","description":"If an IP range is specified, the range may contain no more than 64\nIP addresses.\n","maxItems":64,"title":"List of Ip address or ip range"}}}]},"FirewallStatus":{"x-vmw-nsx-module":"FirewallStatus","allOf":[{"$ref":"#/definitions/ManagedResource"},{"required":["global_status","context"],"x-vmw-nsx-module":"FirewallStatus","type":"object","properties":{"global_status":{"description":"Firewall status for a fabric entity or in global context where firewall is supported.","enum":["DISABLED","ENABLED"],"readOnly":false,"type":"string"},"context":{"description":"Types of firewall contexts.","enum":["transport_nodes","logical_routers","bridge_ports"],"readOnly":false,"type":"string"},"target_statuses":{"items":{"$ref":"#/definitions/TargetResourceStatus"},"readOnly":false,"type":"array","description":"List of firewall status on various target logical resources. This will override the global status of corresponding firewall context (e.g it will override the gloabal status of logical_routers).","title":"List of target resource status"}}}],"description":"Firewall Status Response","title":"Firewall Status Response"},"DiscoveredNodeInterfaceProperties":{"x-vmw-nsx-module":"InventoryCmObj","type":"object","description":"Network interface properties of discovered node","properties":{"physical_address":{"description":"Mac address of the interface","format":"mac-address","type":"string"},"connected_switch":{"type":"string","description":"Switch name which is connected to nic, switch can be opaque, proxyHostSwitch or virtual","title":"Connected switch"},"connected_switch_type":{"enum":["VSS","DVS","N-VDS"],"type":"string","description":"Type of virtual switch can be VSS, DVS or N-VDS.","title":"Type of virtual switch"},"interface_id":{"type":"string","description":"Id of the network interface","title":"Interface ID"}},"title":"Discovered node network interface properties"},"OperationCollector":{"x-vmw-nsx-module":"GlobalConfigs","required":["collector_port","collector_ip"],"type":"object","description":"The operation collector is defined to receive stats from hosts. (eg. vRNI-collector collects all the system metrics)","properties":{"collector_port":{"description":"Port for the operation collector.","format":"int32","title":"Port for the operation collector","maximum":65535,"minimum":0,"type":"integer"},"tracing_port":{"description":"Port for the Wavefront tracing.","format":"int32","title":"Port for the Wavefront tracing","maximum":65535,"minimum":0,"type":"integer"},"collector_type":{"default":"VRNI","enum":["VRNI","WAVE_FRONT"],"type":"string","description":"Define the operation collector type.","title":"The operation collector type"},"collector_ip":{"description":"IP address for the operation collector.","format":"ip","type":"string"}}},"LogicalConstructMigrationStats":{"x-vmw-nsx-module":"Migration","type":"object","description":"Contains migration related information about logical constructs","properties":{"source_type":{"readOnly":true,"type":"string","description":"Type of the vSphere object (e.g. dvportgroup).","title":"Type of the vSphere object"},"source_count":{"readOnly":true,"type":"string","description":"Number of objects of source type.","title":"Number of objects of source type"},"vertical":{"readOnly":true,"type":"string","description":"Functional area that this vSphere object falls into","title":"Functional area for the vSphere object"},"site_id":{"readOnly":true,"type":"string","description":"Federation site id.","title":"Federation site id"},"target_type":{"readOnly":true,"type":"string","description":"Type of the Policy object corresponding to the source type (e.g. Segment).","title":"Type of the Policy object"},"target_count":{"readOnly":true,"type":"string","description":"Number of objects of target type.","title":"Number of objects of target type"}},"title":"Migration Statistics for Logical Constructs"},"EdgeNodeDeploymentConfig":{"x-vmw-nsx-module":"FabricNode","required":["node_user_settings","vm_deployment_config"],"type":"object","properties":{"node_user_settings":{"$ref":"#/definitions/NodeUserSettings"},"vm_deployment_config":{"$ref":"#/definitions/DeploymentConfig"},"form_factor":{"description":"Supported edge form factor.","default":"MEDIUM","enum":["SMALL","MEDIUM","LARGE","XLARGE"],"type":"string"}}},"PolicyBasedIPSecVPNSession":{"x-vmw-nsx-module":"IPSecVPN","allOf":[{"$ref":"#/definitions/IPSecVPNSession"},{"required":["policy_rules"],"x-vmw-nsx-module":"IPSecVPN","type":"object","properties":{"policy_rules":{"items":{"$ref":"#/definitions/IPSecVPNPolicyRule"},"type":"array","description":"Policy rules","title":"Policy rules"}}}],"description":"A Policy Based VPN requires to define protect rules that match local and peer subnets. IPSec security associations is negotiated for each pair of local and peer subnet.","title":"Policy based VPN session"},"LbClientCertificateIssuerDnCondition":{"description":"Match condition for client certficate issuer DN","title":"Match condition for client certficate issuer DN","required":["issuer_dn"],"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"case_sensitive":{"default":true,"type":"boolean","description":"If true, case is significant when comparing issuer DN value.\n","title":"A case sensitive flag for issuer DN comparing"},"match_type":{"description":"Match type of issuer DN","default":"REGEX","enum":["STARTS_WITH","ENDS_WITH","EQUALS","CONTAINS","REGEX"],"type":"string"},"issuer_dn":{"type":"string","description":"Value of issuer DN","title":"Value of issuer DN"}}},"FileThumbprint":{"x-vmw-nsx-module":"MISSING_MODULE","allOf":[{"$ref":"#/definitions/Resource"},{"required":["sha256","name","sha1"],"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"sha256":{"type":"string","description":"File's SHA256 thumbprint","title":"File's SHA256 thumbprint"},"name":{"type":"string","description":"File name","title":"File name"},"sha1":{"type":"string","description":"File's SHA1 thumbprint","title":"File's SHA1 thumbprint"}}}],"description":"File thumbprint","title":"File thumbprint"},"CrlList":{"x-vmw-nsx-module":"CertificateManager","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"CertificateManager","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/Crl"},"readOnly":true,"type":"array","description":"CRL list."}}}],"description":"Crl queries result","title":"Crl queries result"},"RemainingSupportBundleNode":{"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"status":{"readOnly":true,"enum":["PENDING","PROCESSING"],"type":"string","description":"Status of node","title":"Status of node"},"node_display_name":{"readOnly":true,"type":"string","description":"Display name of node","title":"Display name of node"},"node_id":{"readOnly":true,"type":"string","description":"UUID of node","title":"UUID of node"}}},"AdvertisementRuleFilter":{"x-vmw-nsx-module":"Routing","required":["prefix_operator","match_route_types"],"type":"object","description":"To filter the routes advertised by the TIER1 LR to TIER0 LR. Filtering will be based on the type of route and the prefix operator configured.","properties":{"prefix_operator":{"default":"GE","enum":["GE","EQ"],"type":"string","description":"GE prefix operator filters all the routes having network subset of any of the networks configured in Advertise rule. EQ prefix operator filter all the routes having network equal to any of the network configured in Advertise rule.","title":"Prefix operator to apply on networks"},"match_route_types":{"minItems":1,"items":{"description":"Route types to filter the routes advertised by TIER1 LR. The ANY type filters all routes advertised by TIER1. The STATIC type is deprecated. Please refer to T1_STATIC. The T1_STATIC type filters STATIC routes advertised by TIER1. The NSX_CONNECTED type is deprecated. Please refer to T1_CONNECTED. The T1_CONNECTED type filters directly connected routes including downlink and CSP networks advertised by TIER1. The T1_NAT type filters routes for NAT rules advertised by TIER1. The T1_LB_VIP type filters LB VIP networks advertised by TIER1. The T1_LB_SNAT type filters routes corresponding to LB SNAT rules advertised by TIER1. The T1_DNSFORWARDER type filters routes for DNS FORWARDER advertised by TIER1. The T1_IPSEC_LOCAL_IP type filters IPSec VPN local endpoint ip addresses to be advertised.","enum":["ANY","STATIC","T1_STATIC","NSX_CONNECTED","T1_CONNECTED","T1_NAT","T1_LB_VIP","T1_LB_SNAT","T1_DNSFORWARDER","T1_IPSEC_LOCAL_IP"],"type":"string"},"type":"array","description":"Array of route types to filter routes","title":"Array of route types to filter routes"}}},"RemoteTunnelStatistics":{"x-vmw-nsx-module":"AggSvcInterSite","type":"object","properties":{"tunnel_destination_address":{"description":"Ip address of remote tunnel destination.","format":"ip","readOnly":true,"type":"string"},"tunnel_source_address":{"description":"Ip address of remote tunnel source.","format":"ip","readOnly":true,"type":"string"},"rx":{"$ref":"#/definitions/InterSitePortCounters"},"tx":{"$ref":"#/definitions/InterSitePortCounters"}}},"PnicBondStatus":{"x-vmw-nsx-module":"Heatmap","type":"object","description":"pNIC/bond statuses","properties":{"status":{"enum":["UNKNOWN","UP","DOWN","DEGRADED"],"type":"string","description":"Status of pNIC/bond","title":"pNic/bond status"},"type":{"enum":["UNKNOWN_TYPE","PNIC","BOND"],"type":"string","description":"type, whether the object is a pNIC or a bond","title":"Object type"},"name":{"type":"string","description":"Name of the pNIC/bond","title":"pNIC/bond name"}},"title":"pNIC/bond status"},"LogicalSwitchStatusSummary":{"x-vmw-nsx-module":"AggSvcLogicalSwitch","required":["total_switches","fully_realized_switches"],"type":"object","properties":{"last_update_timestamp":{"description":"Timestamp when the data was last updated; unset if data source has never updated the data.","format":"int64","readOnly":true,"type":"integer"},"total_switches":{"format":"int64","type":"integer","description":"The total number of logical switches.","title":"The total number of logical switches."},"filters":{"items":{"$ref":"#/definitions/Filter"},"type":"array","description":"The filters used to find the logical switches- TransportZone id, LogicalSwitchProfile id or TransportType","title":"The filters used to find the logical switches- TransportZone id, LogicalSwitchProfile id or TransportType"},"fully_realized_switches":{"format":"int64","type":"integer","description":"The number of logical switches that are realized in all transport nodes.","title":"The number of logical switches that are realized in all transport nodes."}}},"TrustObjectData":{"x-vmw-nsx-module":"CertificateManager","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"CertificateManager","required":["pem_encoded"],"type":"object","properties":{"key_algo":{"type":"string","description":"Key algorithm contained in this certificate."},"private_key":{"readOnly":false,"type":"string","description":"Private key data."},"passphrase":{"readOnly":false,"type":"string","description":"Password for private key encryption."},"pem_encoded":{"readOnly":false,"type":"string","description":"PEM encoded certificate data."},"purpose":{"readOnly":false,"enum":["signing-ca"],"type":"string","description":"Purpose of this certificate. Can be empty or set to \"signing-ca\"."}}}]},"LogicalSwitch":{"x-vmw-nsx-module":"LogicalSwitch","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"LogicalSwitch","required":["transport_zone_id","admin_state"],"type":"object","properties":{"switch_type":{"enum":["DEFAULT","SERVICE_PLANE","DHCP_RELAY","GLOBAL","INTER_ROUTER","EVPN","DVPG"],"type":"string","description":"This field indicates purpose of a LogicalSwitch. It is set by manager internally\nor user can provide this field. If not set, DEFAULT type is assigned.\nNSX components can use this field to create LogicalSwitch that provides component\nspecific functionality.\nDEFAULT type LogicalSwitches are created for basic L2 connectivity by API users.\nSERVICE_PLANE type LogicalSwitches are system created service plane LogicalSwitches for\nService Insertion service. User can not create SERVICE_PLANE type of LogicalSwitch.\nDHCP_RELAY type LogicalSwitches are created by external user like Policy with special\npermissions or by system and will be treated as internal LogicalSwitches. Such\nLogicalSwitch will not be exposed to vSphere user.\nGLOBAL type LogicalSwitches are created to span multiple NSX domains to connect multiple\nremote sites.\nINTER_ROUTER type LogicalSwitches are policy-created LogicalSwitches which\nprovide inter-router connectivity.\nDVPG type LogicalSwitches are NSX-created based on DVPGs found in VC which are used\nas shadow objects in NSX on DVPG.\n","title":"Type of LogicalSwitch."},"span":{"description":"Each manager ID represents the NSX Local Manager the logical switch connects. This will be populated by the manager.","title":"List of Local Manager IDs the logical switch extends","minItems":0,"items":{"type":"string"},"maxItems":16,"type":"array"},"extra_configs":{"items":{"$ref":"#/definitions/ExtraConfig"},"type":"array","description":"This property could be used for vendor specific configuration in key value\nstring pairs, the setting in extra_configs will be automatically inheritted\nby logical ports in the logical switch.\n","title":"Extra configs on logical switch"},"uplink_teaming_policy_name":{"type":"string","description":"This name has to be one of the switching uplink teaming policy names listed inside the logical switch's TransportZone. If this field is not specified, the logical switch will not have a teaming policy associated with it and the host switch's default teaming policy will be used.","title":"The name of the switching uplink teaming policy for the logical switch"},"address_bindings":{"description":"Address bindings for the Logical switch","title":"Address bindings for the Logical switch","minItems":0,"items":{"$ref":"#/definitions/PacketAddressClassifier"},"x-deprecated":true,"maxItems":100,"type":"array"},"ip_pool_id":{"type":"string","description":"IP pool id that associated with a LogicalSwitch.","title":"Allocation ip pool associated with the Logical switch"},"vlan":{"type":"integer","description":"This property is dedicated to VLAN based network, to set VLAN of logical\nnetwork. It is mutually exclusive with 'vlan_trunk_spec'.\n","format":"int64"},"hybrid":{"default":false,"type":"boolean","description":"If this flag is set to true, then all the logical switch ports attached to\nthis logical switch will behave in a hybrid fashion. The hybrid logical switch port\nindicates to NSX that the VM intends to operate in underlay mode,\nbut retains the ability to forward egress traffic to the NSX overlay network.\nThis flag can be enabled only for the logical switches in the overlay type transport zone which has\nhost switch mode as STANDARD and also has either CrossCloud or CloudScope tag scopes.\nOnly the NSX public cloud gateway (PCG) uses this flag, other host agents like ESX, KVM and Edge\nwill ignore it. This property cannot be modified once the logical switch is created.\n","title":"Flag to identify a hybrid logical switch"},"mac_pool_id":{"type":"string","description":"Mac pool id that associated with a LogicalSwitch.","title":"Allocation mac pool associated with the Logical switch"},"vni":{"format":"int32","type":"integer","description":"Only for OVERLAY network. A VNI will be auto-allocated from the\ndefault VNI pool if not given; otherwise the given VNI has to be\ninside the default pool and not used by any other LogicalSwitch.\n","title":"VNI for this LogicalSwitch."},"vlan_trunk_spec":{"$ref":"#/definitions/VlanTrunkSpec"},"admin_state":{"enum":["UP","DOWN"],"type":"string","description":"Represents Desired state of the Logical Switch","title":"Represents Desired state of the Logical Switch"},"node_local_switch":{"type":"boolean","description":"A flag to prevent BUM (broadcast, unknown-unicast and multicast) traffic from reaching the other spanned edges.","title":"A flag to prevent BUM (broadcast, unknown-unicast and multicast) traffic from reaching the other spanned edges."},"transport_zone_id":{"type":"string","description":"Id of the TransportZone to which this LogicalSwitch is associated","title":"Id of the TransportZone to which this LogicalSwitch is associated"},"replication_mode":{"enum":["MTEP","SOURCE"],"type":"string","description":"Replication mode of the Logical Switch","title":"Replication mode of the Logical Switch"},"switching_profile_ids":{"items":{"$ref":"#/definitions/SwitchingProfileTypeIdEntry"},"type":"array"},"origin_id":{"readOnly":true,"type":"string","description":"ID populated by NSX when NSX on DVPG is used to indicate the source DVPG.","title":"ID of the LS of type DVPG in the source vCenter"},"origin_type":{"readOnly":true,"enum":["VCENTER"],"type":"string","description":"The type of source from which the DVPG is discovered","title":"The type of source from which the DVPG is discovered"},"global_vni":{"format":"int32","type":"integer","description":"The VNI is used for intersite traffic and the global logical switch ID. The global VNI pool is agnostic of the local VNI pool, and there is no need to have an exclusive VNI range. For example, VNI x can be the global VNI for logical switch B and the local VNI for logical switch A.","title":"VNI allocated by the global manager"}}}]},"LbServerSslProfileListResult":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"LoadBalancer","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/LbServerSslProfile"},"type":"array","description":"paginated list of load balancer server SSL profiles","title":"paginated list of load balancer server SSL profiles"}}}]},"Snmpv3Properties":{"x-vmw-nsx-module":"CentralConfig","type":"object","description":"This object contains list of SNMP v3 users used to poll NSX nodes over SNMP and list of SNMP v3 targets used to receive SNMP traps/notifications from NSX nodes. Users specified in a SNMP v3 target must exist in the list of SNMP v3 users.","properties":{"auth_protocol":{"default":"SHA1","enum":["SHA1"],"type":"string","description":"Authentication protocol used for SNMP v3 communication.","title":"Authentication protocol"},"priv_protocol":{"default":"AES128","enum":["AES128"],"type":"string","description":"Privacy protocol used for SNMP v3 communication.","title":"Privacy protocol"},"users":{"items":{"$ref":"#/definitions/Snmpv3User"},"type":"array","description":"List of SNMP v3 users allowed to poll NSX nodes over SNMP. Also, users specified in a SNMP v3 target must exist in this list.","maxItems":5,"title":"SNMP v3 users"},"targets":{"items":{"$ref":"#/definitions/Snmpv3Target"},"type":"array","description":"List of SNMP v3 targets/receivers where SNMP v3 traps/notifications will be sent from NSX nodes.","maxItems":3,"title":"SNMP v3 targets"}},"title":"SNMP v3 properties"},"DhcpV6IpPoolListResult":{"x-vmw-nsx-module":"Dhcp","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"Dhcp","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/DhcpV6IpPool"},"type":"array","description":"A paginated list of DHCP IPv6 ip pools.","title":"Paginated list of DHCP IPv6 ip pools"}}}],"description":"A paginated list of DHCP IPv6 ip pools.","title":"A list of DHCP IPv6 ip pools"},"NatRule":{"x-vmw-nsx-module":"Nat","allOf":[{"$ref":"#/definitions/ManagedResource"},{"required":["action"],"x-vmw-nsx-module":"Nat","type":"object","properties":{"match_destination_network":{"type":"string","description":"IP Address | CIDR | (null implies Any)\n","title":"match destination network"},"translated_network":{"type":"string","description":"The translated address for the matched IP packet. For a SNAT, it can be\na single ip address, an ip range, or a CIDR block. For a DNAT and\na REFLEXIVE, it can be a single ip address or a CIDR block. Translated\nnetwork is not supported for NO_SNAT or NO_DNAT.\n","title":"IP Address | IP Range | CIDR"},"rule_priority":{"default":1024,"format":"int64","type":"integer","description":"Ascending, valid range [0-2147483647]. If multiple rules have the same\npriority, evaluation sequence is undefined.\n","title":"NAT rule priority"},"match_service":{"$ref":"#/definitions/NSServiceElement"},"applied_tos":{"items":{"$ref":"#/definitions/ResourceReference"},"type":"array","description":"Holds the list of LogicalRouterPort Ids that a NAT rule can be applied to. The LogicalRouterPort used must belong to the same LogicalRouter for which the NAT Rule is created. As of now a NAT rule can only have a single LogicalRouterPort as applied_tos. When applied_tos is not set, the NAT rule is applied to all LogicalRouterPorts beloging to the LogicalRouter.","maxItems":1,"title":"List of LogicalRouterPort resources as applied to"},"enabled":{"default":true,"type":"boolean","description":"Indicator to enable/disable the rule.\n","title":"enable/disable the rule"},"internal_rule_id":{"readOnly":true,"type":"string","description":"Internal NAT rule uuid for debug used in Controller and backend.","title":"Internal NAT rule uuid"},"logging":{"default":false,"type":"boolean","description":"Enable/disable the logging of rule.\n","title":"Enable/disable the logging of rule"},"translated_ports":{"type":"string","description":"The translated port(s) for the mtached IP packet. It can be a single\nport or a port range. Please note, port translating is supported only\nfor DNAT.\n","title":"port number or port range. DNAT only"},"action":{"description":"Valid actions: SNAT, DNAT, NO_SNAT, NO_DNAT, REFLEXIVE, NAT64. All\nrules in a logical router are either stateless or stateful. Mix is\nnot supported. SNAT and DNAT are stateful, can NOT be supported when\nthe logical router is running at active-active HA mode; REFLEXIVE\nis stateless. NO_SNAT and NO_DNAT have no translated_fields, only\nmatch fields are supported.\n","enum":["SNAT","DNAT","REFLEXIVE","NO_SNAT","NO_DNAT","NAT64"],"type":"string"},"firewall_match":{"description":"Indicate how firewall is applied to a traffic packet. Firewall can be\nbypassed, or be applied to external/internal address of NAT rule.\n\nThe firewall_match will take priority over nat_pass. If the firewall_match\nis not provided, the nat_pass will be picked up.\n","enum":["MATCH_EXTERNAL_ADDRESS","MATCH_INTERNAL_ADDRESS","BYPASS"],"type":"string"},"nat_pass":{"default":true,"type":"boolean","description":"Default is true. If the nat_pass is set to true, the following firewall\nstage will be skipped. Please note, if action is NO_SNAT or NO_DNAT,\nthen nat_pass must be set to true or omitted.\n\nNat_pass was deprecated with an alternative firewall_match. Please stop\nusing nat_pass to specify whether firewall stage is skipped. if you want\nto skip, please set firewall_match to BYPASS. If you do not want to skip,\nplease set the firewall_match to MATCH_EXTERNAL_ADDRESS or\nMATCH_INTERNAL_ADDRESS.\n\nPlease note, the firewall_match will take priority over the nat_pass.\nIf both are provided, the nat_pass is ignored. If firewall_match is not\nprovided while the nat_pass is specified, the nat_pass will still be\npicked up. In this case, if nat_pass is set to false, firewall rule will\nbe applied on internall address of a packet, i.e. MATCH_INTERNAL_ADDRESS.\n","x-deprecated":true,"title":"enable/disable to bypass following firewall stage"},"logical_router_id":{"readOnly":true,"type":"string","description":"The logical router id which the nat rule runs on.","title":"Logical router id"},"match_source_network":{"type":"string","description":"IP Address | CIDR | (null implies Any)\n","title":"match source network"}}}],"description":"The configuration entity to define a NAT rule. It defines how an ip packet\nis matched via source address or/and destination address or/and service(s),\nhow the address (and/or) port is translated, and how the related firewall\nstage is involved or bypassed.\n","title":"The configuration entity to define a NAT rule"},"TransportNodeStatus":{"x-vmw-nsx-module":"Heatmap","type":"object","properties":{"status":{"enum":["UP","DOWN","DEGRADED","UNKNOWN"],"type":"string","description":"Roll-up status of pNIC, management connection, control connection, tunnel status, agent status","title":"Roll-up status of connections"},"threat_status":{"$ref":"#/definitions/ThreatStatus"},"node_uuid":{"type":"string","description":"Transport node uuid","title":"Transport node uuid"},"control_connection_status":{"$ref":"#/definitions/StatusCount"},"pnic_status":{"$ref":"#/definitions/StatusCount"},"node_path":{"type":"string","description":"Transport node path","title":"Transport node path"},"agent_status":{"$ref":"#/definitions/AgentStatusCount"},"node_status":{"$ref":"#/definitions/NodeStatus"},"mgmt_connection_status":{"enum":["UP","DOWN"],"type":"string","description":"Management connection status","title":"Management connection status"},"node_display_name":{"type":"string","description":"Transport node display name","title":"Display name"},"tunnel_status":{"$ref":"#/definitions/TunnelStatusCount"}}},"RaDNSConfig":{"x-vmw-nsx-module":"Routing","type":"object","properties":{"domain_name_lifetime":{"description":"Lifetime of Domain names in milliseconds","title":"Lifetime of Domain names in milliseconds","default":1800000,"format":"int64","maximum":4294967295,"minimum":0,"type":"integer"},"dns_server":{"items":{"description":"IPv6 address","format":"ipv6","type":"string"},"type":"array","description":"DNS server.\n","maxItems":8,"title":"DNS server"},"domain_name":{"items":{"type":"string"},"type":"array","description":"Domain name in RA message.\n","maxItems":8,"title":"Domain name"},"dns_server_lifetime":{"description":"Lifetime of DNS server in milliseconds","title":"Lifetime of DNS server in milliseconds","default":1800000,"format":"int64","maximum":4294967295,"minimum":0,"type":"integer"}}},"IpfixServiceAssociationListResult":{"x-vmw-nsx-module":"GroupingObjectsProviders","allOf":[{"$ref":"#/definitions/ServiceAssociationListResult"},{"x-vmw-nsx-module":"GroupingObjectsProviders","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/IpfixConfig"},"readOnly":true,"type":"array","description":"Ipfix config list result with pagination support.","title":"IpfixConfig list result"}}}]},"CentralNodeConfigProfile":{"x-vmw-nsx-module":"CentralConfig","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"CentralConfig","type":"object","properties":{"syslog":{"$ref":"#/definitions/SyslogProperties"},"timezone":{"type":"string","description":"Timezone to be set for NSX nodes. Only timezone strings listed in the Time Zone database (https://www.iana.org/time-zones) are allowed.","title":"Timezone"},"snmp":{"$ref":"#/definitions/SnmpProperties"},"ntp":{"$ref":"#/definitions/NtpProperties"}}}],"description":"Central Node Config profile for NSX nodes. This set of properties will be pushed to NSX Manager and Edge nodes. SNMP properties will be pushed to KVM Hypervisors in addition to Manager and Edge nodes.","title":"Central Node Config Profile"},"FailureDomain":{"x-vmw-nsx-module":"FailureDomain","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"FailureDomain","type":"object","properties":{"preferred_active_edge_services":{"type":"boolean","description":"Set preference for edge transport node failure domain which will be\nconsidered while doing auto placement of logical router, DHCP and\nMDProxy on edge node.\ntrue: For preemptive failover mode, active edge cluster member\n allocation preferes this failure domain.\nfalse: For preemptive failover mode, standby edge cluster member\n allocation preferes this failure domain.\nDefault will be unset. It means no explicit preference.\n","title":"Set preference for failure domain"}}}],"description":"Failure Domain is engineered to be isolated from failures in other failure\ndomains, and to provide inexpensive, low-latency network connectivity to\nother failure domains in the same region. We support failure domain only on\nedge transport node. Like you can consider one rack as one failure domain\nand place active-standby contexts like logical router, DHCP and MDProxy in\ntwo different failure domains (racks). So failure of a single rack (FD) does\nnot impact any services and other rack (FD) will continue to handle traffic.\nInitially system creates one default failure domain. For any edge transport\nnode, if failure domains is not given, it will be mapped to default system\ngenerated failure domain. You can't update preferred_active_edge_services\nflag for system generated default failure domain. It will be unset which\nmeans that failure domain can be used for both active and standby allocation.\n","title":"Failure Domain for edge transport node"},"UcUpgradeStatus":{"x-vmw-nsx-module":"Upgrade","type":"object","description":"Upgrade status of upgrade-coordinator","properties":{"status":{"readOnly":true,"type":"string","description":"Status of UC upgrade.","title":"Status of UC upgrade"},"progress_messages":{"items":{"type":"string"},"readOnly":true,"type":"array","description":"List of progress messages.","title":"Progress messages"},"state":{"readOnly":true,"enum":["NOT_STARTED","IN_PROGRESS","SUCCESS","FAILED"],"type":"string","description":"Current state of UC upgrade","title":"State of UC upgrade"},"errors":{"items":{"type":"string"},"readOnly":true,"type":"array","description":"List of failure messages.","title":"List of failure messages"},"progress_percentage":{"readOnly":true,"format":"int32","type":"integer","description":"Upgrade Coordinator Upgrade Progress Percentage","title":"Upgrade Coordinator Upgrade Progress Percentage"}},"title":"UC Upgrade status"},"NatStatisticsPerLogicalRouter":{"x-vmw-nsx-module":"AggSvcLogicalRouter","type":"object","properties":{"last_update_timestamp":{"description":"Timestamp when the data was last updated; unset if data source has never updated the data.","format":"int64","readOnly":true,"type":"integer"},"per_transport_node_statistics":{"items":{"$ref":"#/definitions/NatStatisticsPerTransportNode"},"readOnly":true,"type":"array","description":"Detailed per node statistics","title":"Detailed per node statistics"},"statistics_across_all_nodes":{"$ref":"#/definitions/NatCounters"},"logical_router_id":{"readOnly":true,"type":"string","description":"Id for the logical router","title":"Id for the logical router"}}},"SyslogExporter":{"description":"This object specifies what, where and how logs on NSX nodes are forwarded.","title":"Syslog exporter properties","required":["max_log_level","protocol","server"],"x-vmw-nsx-module":"CentralConfig","type":"object","properties":{"max_log_level":{"enum":["EMERG","ALERT","CRIT","ERR","WARNING","NOTICE","INFO","DEBUG"],"type":"string","description":"Maximum logging level for messages to be exported.","title":"LogLevel"},"protocol":{"enum":["TCP","UDP","LI"],"type":"string","description":"Protocol to be used to export logs to syslog server.","title":"Protocol"},"port":{"description":"Server port on which syslog listener is listening.","title":"Syslog port","default":514,"format":"int64","maximum":65535,"minimum":1,"type":"integer"},"server":{"description":"Syslog server IP address or hostname.","format":"hostname-or-ipv4","type":"string"}}},"SnmpServiceProperties":{"description":"SNMP Service properties","title":"SNMP Service properties","required":["v3_auth_protocol","v3_priv_protocol","start_on_boot"],"x-vmw-nsx-module":"CentralNodeConfig","type":"object","properties":{"v3_auth_protocol":{"default":"SHA1","enum":["SHA1"],"type":"string","description":"SNMP v3 auth protocol","title":"SNMP v3 auth protocol"},"communities":{"items":{"type":"string"},"type":"array","description":"SNMP v1, v2c community strings","maxItems":1,"title":"SNMP v1, v2c community strings"},"v3_configured":{"readOnly":true,"type":"boolean","description":"SNMP v3 is configured or not","title":"SNMP v3 is configured or not"},"v3_priv_protocol":{"default":"AES128","enum":["AES128"],"type":"string","description":"SNMP v3 private protocol","title":"SNMP v3 private protocol"},"v3_users":{"items":{"$ref":"#/definitions/SnmpV3User"},"type":"array","description":"SNMP v3 users information","maxItems":1,"title":"V3 users"},"v2_configured":{"readOnly":true,"type":"boolean","description":"SNMP v2 is configured or not","title":"SNMP v2 is configured or not"},"start_on_boot":{"type":"boolean","description":"Start when system boots","title":"Start when system boots"}}},"CommunityMatchExpression":{"description":"Community match expression","title":"Community match expression","required":["expression"],"x-vmw-nsx-module":"Routing","type":"object","properties":{"operator":{"readOnly":true,"enum":["AND"],"type":"string","description":"Operator for evaluating community match expressions.\nAND logical AND operator\n","title":"Operator"},"expression":{"items":{"$ref":"#/definitions/CommunityMatchOperation"},"type":"array","description":"Array of community match operations","title":"Array of community match operations"}}},"EffectiveIPInfo":{"description":"List of effective ip address along with site id","title":"List of effective ip address along with site id","required":["effective_ips","site_id"],"x-vmw-nsx-module":"GroupingObjectsProviders","type":"object","properties":{"effective_ips":{"items":{"description":"IPElement can be a single IP address, IP address range or a Subnet. Its\ntype can be of IPv4 or IPv6. Supported list of formats are \"192.168.1.1\",\n\"192.168.1.1-192.168.1.100\", \"192.168.0.0/24\",\n\"fe80::250:56ff:fe83:318c\",\n\"fe80::250:56ff:fe83:3181-fe80::250:56ff:fe83:318c\",\n\"fe80::250:56ff:fe83:318c/64\"\n","format":"address-or-block-or-range","type":"string"},"type":"array"},"site_id":{"type":"string","description":"Id of the site to which the effective IPs belong to\n","title":"Id of the site to which the effective IPs belong to\n"}}},"DnsForwarderListResult":{"x-vmw-nsx-module":"DnsForwarder","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"DnsForwarder","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/DnsForwarder"},"type":"array","description":"Paginated list of DNS forwarders","title":"Paginated list of DNS forwarders"}}}]},"RemoteServerFingerprintRequest":{"description":"Remote server","title":"Remote server","required":["server"],"x-vmw-nsx-module":"BackupConfiguration","type":"object","properties":{"port":{"description":"Server port","title":"Server port","default":22,"format":"int64","maximum":65535,"minimum":1,"type":"integer"},"server":{"format":"hostname-or-ip","type":"string","description":"Remote server hostname or IP address","title":"Remote server hostname or IP address"}}},"IntelligenceFormFactors":{"x-vmw-nsx-module":"MISSING_MODULE","type":"object","description":"Napp cluster form factors list result","properties":{"form_factors":{"items":{"$ref":"#/definitions/IntelligenceFormFactor"},"type":"array","description":"Napp cluster form factor list","title":"Napp cluster form factor list"}},"title":"Napp cluster form factors list result"},"CallbackAuthenticationScheme":{"x-vmw-nsx-module":"ServiceInsertionCommonTypes","required":["scheme_name"],"type":"object","description":"CallbackAuthenticationScheme describes how notification requests should authenticate to the server.","properties":{"username":{"readOnly":false,"type":"string","description":"Username to use if scheme_name is BASIC_AUTH.","title":"Username for authentication"},"certificate_id":{"readOnly":false,"type":"string","description":"Certificate ID with a valid certificate and private key, procured from trust-management API.","title":"Valid certificate ID"},"scheme_name":{"readOnly":false,"enum":["BASIC_AUTH","CERTIFICATE"],"type":"string","description":"Authentication scheme to use when making notification requests to the partner console. Specify one of BASIC_AUTH or CERTIFICATE.","title":"Authentication scheme to use when making notification requests"},"password":{"readOnly":false,"type":"string","description":"Password to use if scheme_name is BASIC_AUTH.","title":"Password for authentication"}}},"TokenBasedPrincipalIdentityListResult":{"x-vmw-nsx-module":"CertificateManager","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"CertificateManager","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/TokenBasedPrincipalIdentity"},"readOnly":false,"type":"array","description":"TokenBasedPrincipalIdentity list."}}}],"description":"Token-based PrincipalIdentity query result","title":"Token-based PrincipalIdentity query result"},"NsxtSite":{"x-vmw-nsx-module":"Migration","type":"object","description":"Details about NSX-T site.","properties":{"federation_site_display_name":{"readOnly":true,"type":"string","description":"Display name for the federation site.","title":"Display name for the federation site"},"federation_site_id":{"readOnly":true,"type":"string","description":"Federation site id.","title":"Federation site id"},"nsxt_ip":{"readOnly":true,"format":"hostname-or-ip","type":"string","description":"IP address of NSX-T appliance at the site.","title":"IP address of NSX-T appliance"},"federation_site_type":{"readOnly":true,"enum":["GlobalManager","Site"],"type":"string","description":"Type of federation site. It can be GlobalManager or Site.","title":"Type of the federation site"}},"title":"Details about NSX-T site"},"CentralConfigProperties":{"description":"Central Config properties","title":"Central Config properties","required":["local_override"],"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"local_override":{"type":"boolean","description":"Override Central Config","title":"Override Central Config"}}},"ContainerNetworkPolicyListResult":{"x-vmw-nsx-module":"InventoryContainerObj","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"InventoryContainerObj","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/ContainerNetworkPolicy"},"type":"array","description":"List of Container Network Policy specs","title":"List of Container Network Policy specs"}}}]},"SvmConnectivityStatus":{"x-vmw-nsx-module":"VmToolsInfo","allOf":[{"$ref":"#/definitions/DiscoveredResource"},{"x-vmw-nsx-module":"VmToolsInfo","type":"object","properties":{"service_name":{"readOnly":true,"type":"string","description":"Service name as provided for Anti Malware Solution or as provided for third party Endpoint Protection solution during service registration.","title":"Service name of Solution"},"solution_id":{"readOnly":true,"type":"string","description":"Solution ID as provided for Anti Malware Solution(AMS) or as provided for third party Endpoint Protection(EPP) solution during service registration.","title":"SVM solutionID"},"connectivity_status":{"readOnly":true,"type":"boolean","description":"Connectivity status with the deployed Solution VM TRUE - VM is configured and protected by EPP/AMS Service VM. FALSE - VM is either not configured for protection or VM is disconnected from EPP/AMS Service VM.","title":"Connectivity status with SVM"}}}]},"IDSProfile":{"x-vmw-nsx-module":"IDSProfile","allOf":[{"$ref":"#/definitions/ManagedResource"},{"required":["signatures"],"x-vmw-nsx-module":"IDSProfile","type":"object","properties":{"signatures":{"description":"List of IDS signatures ids which need to be detected.","title":"IDS Signatures","minItems":1,"items":{"type":"string"},"readOnly":false,"maxItems":30000,"type":"array"}}}],"description":"An entity that holds the list of IDS signatures which need to be detected. The profiles can be custom created or built in.","title":"IDS Profile"},"InitiateClusterRestoreRequest":{"x-vmw-nsx-module":"ClusterRestore","type":"object","properties":{"timestamp":{"description":"Timestamp of the backed-up configuration from which\nthe appliance will be restored\n","format":"int64","readOnly":true,"type":"integer"},"node_id":{"readOnly":true,"type":"string","description":"Unique id of the backed-up configuration from which\nthe appliance will be restored\n","title":"Unique id of the backed-up configuration from which\nthe appliance will be restored\n"},"ip_address":{"readOnly":true,"format":"hostname-or-ip","type":"string","description":"IP address or FQDN of the node from which the backup was taken","title":"IP address or FQDN of the node from which the backup was taken"}}},"NvdsUpgradeConfigIssue":{"x-vmw-nsx-module":"NvdsUpgradeReadinessCheck","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"NvdsUpgradeReadinessCheck","type":"object","properties":{"recommendation":{"readOnly":true,"type":"string","description":"Recommendation to resolve the error returned for component","title":"Recommendation to resolve the error returned for component"},"component":{"readOnly":true,"type":"string","description":"Name of the component/object","title":"Name of the component/object"},"objid":{"readOnly":true,"type":"string","description":"Id of the object that generated error","title":"Id of the object that generated error"},"error":{"readOnly":true,"type":"string","description":"Error for the component describing precheck failure","title":"Error for the component describing precheck failure"}}}],"description":"Issues reported by upgrade readiness check","title":"Issues reported by upgrade readiness check"},"UnassociatedVMListResult":{"x-vmw-nsx-module":"GroupingObjectsProviders","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"GroupingObjectsProviders","required":["results"],"type":"object","properties":{"last_update_timestamp":{"type":"integer","description":"Timestamp in milliseconds since epoch","format":"int64"},"results":{"items":{"$ref":"#/definitions/VirtualMachine"},"type":"array","description":"List of VMs which are not associated with any NSGroup\n","title":"Unassociated Vitual Machine list results\n"}}}]},"StandardHostSwitchSpec":{"x-vmw-nsx-module":"TransportNode","allOf":[{"$ref":"#/definitions/HostSwitchSpec"},{"required":["host_switches"],"x-vmw-nsx-module":"TransportNode","type":"object","properties":{"host_switches":{"minItems":0,"items":{"$ref":"#/definitions/StandardHostSwitch"},"type":"array","description":"Transport Node host switches","title":"Transport Node host switches"}}}],"description":"Standard host switch specification is used for NSX configured transport node.","title":"Specification of transport node standard host switch"},"ReorderRequest":{"x-vmw-nsx-module":"Upgrade","required":["id"],"type":"object","properties":{"is_before":{"default":true,"readOnly":false,"type":"boolean","description":"flag indicating whether the upgrade unit group/upgrade unit is to be placed before or after the specified upgrade unit group/upgrade unit","title":"flag indicating whether the upgrade unit group/upgrade unit is to be placed before or after the specified upgrade unit group/upgrade unit"},"id":{"readOnly":false,"type":"string","description":"id of the upgrade unit group/upgrade unit before/after which the upgrade unit group/upgrade unit is to be placed","title":"id of the upgrade unit group/upgrade unit before/after which the upgrade unit group/upgrade unit is to be placed"}}},"FirewallStatusListResult":{"x-vmw-nsx-module":"FirewallStatus","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"FirewallStatus","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/FirewallStatus"},"readOnly":true,"type":"array"}}}],"description":"List of firewall statuses for a context or all context","title":"Firewall Statuses"},"DhcpV6IpPool":{"x-vmw-nsx-module":"Dhcp","allOf":[{"$ref":"#/definitions/DhcpV6InfoBase"},{"x-vmw-nsx-module":"Dhcp","type":"object","properties":{"ranges":{"description":"Ip address ranges to define dynamic ip allocation ranges.","title":"Ip address ranges","minItems":0,"items":{"$ref":"#/definitions/IpPoolRange"},"maxItems":128,"type":"array"},"excluded_ranges":{"description":"Excluded addresses to define dynamic ip allocation ranges.","title":"Excluded range of IPv6 addresses","minItems":0,"items":{"$ref":"#/definitions/IpPoolRange"},"maxItems":128,"type":"array"}}}],"description":"DHCP IPv6 ip pool to define dynamic ip allocation ranges.\nThe DhcpV6IpPool would only provide stateless DHCP (domain search list,\nDNS servers, SNTP servers) to client if both the ranges and excluded_ranges\nare not specified.\n","title":"DHCP IPv6 ip pool"},"L2VPNSessionRemoteMacsForLS":{"x-vmw-nsx-module":"L2VPNStatistics","type":"object","description":"Remote MAC addresses for logical switch.","properties":{"remote_mac_addresses":{"items":{"type":"string"},"readOnly":true,"type":"array","description":"Mac addresses.","title":"Mac addresses"},"logical_switch":{"$ref":"#/definitions/ResourceReference"},"tags":{"items":{"$ref":"#/definitions/Tag"},"type":"array","description":"Contains policy specific information like policy path.","maxItems":30,"title":"Attributes Tags"}},"title":"Remote MAC addresses for logical switch"},"AttachmentContext":{"discriminator":"resource_type","x-vmw-nsx-module":"LogicalPort","required":["resource_type"],"type":"object","properties":{"allocate_addresses":{"enum":["IpPool","MacPool","Both","None","Dhcp"],"type":"string","description":"A flag to indicate whether to allocate addresses from allocation\n pools bound to the parent logical switch.\n","title":"A flag to indicate whether to allocate addresses from allocation\n pools bound to the parent logical switch.\n"},"resource_type":{"type":"string","description":"Used to identify which concrete class it is","title":"Used to identify which concrete class it is"}}},"PluginStatus":{"x-vmw-nsx-module":"SystemHealthPlugin","type":"object","description":"Describes plugin status on node\n","properties":{"status":{"readOnly":true,"enum":["UNKNOWN","ENABLED","DISABLED"],"type":"string","description":"Plugin status."},"profile":{"readOnly":true,"type":"string","description":"Display the plugin profile content.","title":"Plugin profile"},"detail":{"readOnly":true,"type":"string","description":"Detail information of plugin.","title":"Detail information of plugin"},"id":{"readOnly":true,"type":"string","description":"Plugin id.","title":"Plugin id"},"name":{"readOnly":true,"type":"string","description":"Plugin name.","title":"Plugin name"}},"title":"System Health Plugin status"},"UpgradeUnitAggregateInfo":{"x-vmw-nsx-module":"Upgrade","allOf":[{"$ref":"#/definitions/Resource"},{"x-vmw-nsx-module":"Upgrade","type":"object","properties":{"status":{"readOnly":true,"enum":["SUCCESS","FAILED","IN_PROGRESS","NOT_STARTED","PAUSING","PAUSED"],"type":"string","description":"Status of upgrade unit","title":"Status of upgrade unit"},"pre_upgrade_checks":{"$ref":"#/definitions/UpgradeCheckListResults"},"errors":{"items":{"type":"string"},"readOnly":true,"type":"array","description":"List of errors occurred during upgrade of this upgrade unit","title":"List of errors occurred during upgrade of this upgrade unit"},"display_name":{"readOnly":false,"type":"string","description":"Name of the upgrade unit","title":"Name of the upgrade unit"},"post_upgrade_checks":{"$ref":"#/definitions/UpgradeCheckListResults"},"warnings":{"items":{"type":"string"},"readOnly":true,"type":"array","description":"List of warnings indicating issues with the upgrade unit that may result in upgrade failure","title":"List of warnings indicating issues with the upgrade unit that may result in upgrade failure"},"current_version":{"readOnly":true,"type":"string","description":"This is component version e.g. if upgrade unit is of type edge, then this is edge version.","title":"Current version of upgrade unit"},"group":{"$ref":"#/definitions/UpgradeUnitGroupInfo"},"percent_complete":{"readOnly":true,"type":"number","description":"Indicator of upgrade progress in percentage","title":"Indicator of upgrade progress in percentage"},"type":{"readOnly":false,"type":"string","description":"Upgrade unit type","title":"Upgrade unit type"},"id":{"readOnly":true,"type":"string","description":"Identifier of the upgrade unit","title":"Identifier of the upgrade unit"},"metadata":{"items":{"$ref":"#/definitions/KeyValuePair"},"readOnly":true,"type":"array","description":"Metadata about upgrade unit","title":"Metadata about upgrade unit"}}}]},"ClustersAggregateInfo":{"x-vmw-nsx-module":"ClusterManagement","required":["management_cluster","controller_cluster"],"type":"object","properties":{"management_cluster":{"items":{"$ref":"#/definitions/ManagementNodeAggregateInfo"},"type":"array","description":"Array of Management Nodes","title":"Array of Management Nodes"},"controller_cluster":{"items":{"$ref":"#/definitions/ControllerNodeAggregateInfo"},"type":"array","description":"Array of Controller Nodes","title":"Array of Controller Nodes"},"cluster_status":{"$ref":"#/definitions/AllClusterGroupStatus"}}},"LbSnatAutoMap":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/LbSnatTranslation"},{"x-vmw-nsx-module":"LoadBalancer","type":"object"}]},"IntervalBackupSchedule":{"x-vmw-nsx-module":"BackupConfiguration","allOf":[{"$ref":"#/definitions/BackupSchedule"},{"x-vmw-nsx-module":"BackupConfiguration","type":"object","properties":{"seconds_between_backups":{"description":"Time interval in seconds between two consecutive automated backups","title":"Time interval in seconds between two consecutive automated backups","default":3600,"format":"int64","maximum":86400,"minimum":300,"type":"integer"}}}],"description":"Schedule to specify the interval time at which automated backups need to be taken","title":"Schedule to specify the interval time at which automated backups need to be taken"},"LbHttpRejectAction":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/LbRuleAction"},{"required":["reply_status"],"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"reply_status":{"type":"string","description":"HTTP response status code","title":"HTTP response status code"},"reply_message":{"type":"string","description":"Response message","title":"Response message"}}}],"description":"This action is used to reject HTTP request messages. The specified\nreply_status value is used as the status code for the corresponding HTTP\nresponse message which is sent back to client (Normally a browser)\nindicating the reason it was rejected. Reference official HTTP status code\nlist for your specific HTTP version to set the reply_status properly.\nLbHttpRejectAction does not support variables.\n","title":"Action to reject HTTP request messages"},"PreconfiguredEndpoint":{"description":"Tunnel endpoint configuration of preconfigured host switch","title":"Tunnel endpoint configuration of preconfigured host switch","required":["device_name"],"x-vmw-nsx-module":"TransportNode","type":"object","properties":{"device_name":{"readOnly":false,"type":"string","description":"Name of the virtual tunnel endpoint","title":"Name of the virtual tunnel endpoint"}}},"FeatureUsageList":{"x-vmw-nsx-module":"License","description":"list of feature usage items","allOf":[{"$ref":"#/definitions/Resource"},{"x-vmw-nsx-module":"License","type":"object","properties":{"feature_usage_info":{"items":{"$ref":"#/definitions/FeatureUsage"},"readOnly":true,"type":"array","description":"Feature Usage List","title":"Feature Usage List"}}}]},"LbVirtualServerListResult":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"LoadBalancer","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/LbVirtualServer"},"type":"array","description":"paginated list of virtual servers","title":"paginated list of virtual servers"}}}]},"BinaryPacketData":{"x-vmw-nsx-module":"Traceflow","allOf":[{"$ref":"#/definitions/PacketData"},{"x-vmw-nsx-module":"Traceflow","type":"object","properties":{"payload":{"maxLength":1336,"type":"string","description":"Up to 1000 bytes of payload may be supplied (with a base64-encoded length of 1336 bytes.) Additional bytes of traceflow metadata will be appended to the payload. The payload must contain all headers (Ethernet, IP, etc). Note that VLAN is not supported in the logical space. Hence, payload must not contain 802.1Q headers.","title":"RFC3548 compatible base64 encoded full payload"}}}]},"ConsolidatedEffectiveIPAddressMemberListResult":{"x-vmw-nsx-module":"GroupingObjectsProviders","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"GroupingObjectsProviders","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/EffectiveIPInfo"},"type":"array","description":"Paged Collection of site wise consolidated effective ip addresses for the given NSGroup","title":"Paged Collection of site wise consolidated effective ip addresses for the given NSGroup"}}}]},"DirectoryLdapServerListResults":{"x-vmw-nsx-module":"DirectoryService","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"DirectoryService","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/DirectoryLdapServer"},"type":"array","description":"List of directory domain LDAP servers","maxItems":50,"title":"List of directory domain LDAP servers"}}}],"description":"List of directory domain LDAP servers","title":"List of directory domain LDAP servers"},"DefaultFilterValue":{"description":"An instance of a datasource configuration.","title":"Default filter values","required":["alias","value"],"x-vmw-nsx-module":"NsxDashboard","type":"object","properties":{"alias":{"type":"string","description":"Filter alias.","title":"Filter alias"},"value":{"type":"string","description":"Filter default value.","title":"Filter default value"}}},"MigrationSetupInfo":{"x-vmw-nsx-module":"Migration","type":"object","description":"Details about source and destination NSX setup to be migrated","properties":{"avi_lb_endpoint":{"$ref":"#/definitions/AviEndPoint"},"nsxv_sites":{"items":{"$ref":"#/definitions/SourceNsxApiEndpoint"},"readOnly":true,"type":"array","description":"Comprehensive information about NSX-V multi site setup. This will be populated only when the migration is executed on a cross VC setup.","title":"Comprehensive information about NSX-V multi site setup"},"migration_mode":{"description":"Migration mode can be - - VMC_V2T - ONPREMISE_VSPHERE2T - ONPREMISE_V2T - CMP_VRA - FULL_MIGRATION_WITH_BYOT - FULL_MIGRATION_WITH_BYOT_ON_FEDERATION - FULL_MIGRATION_WITH_BYOT_AND_VRA - FULL_MIGRATION_WITH_BYOT_AND_VRA_ON_FEDERATION - CONFIG_MIGRATION_ONLY_WITH_BYOT - CONFIG_MIGRATION_ONLY_WITH_BYOT_ON_FEDERATION - EDGE_CUTOVER - DFW_ONLY - DFW_WITH_BRIDGED_SEG - DFW_AND_HOST_AND_WORKLOAD - DFW_AND_HOST_AND_WORKLOAD_WITH_BRIDGED_SEG","title":"Migration mode","default":"ONPREMISE_V2T","enum":["VMC_V2T","ONPREMISE_VSPHERE2T","ONPREMISE_V2T","CMP_VRA","FULL_MIGRATION_WITH_BYOT","FULL_MIGRATION_WITH_BYOT_ON_FEDERATION","FULL_MIGRATION_WITH_BYOT_AND_VRA","FULL_MIGRATION_WITH_BYOT_AND_VRA_ON_FEDERATION","CONFIG_MIGRATION_ONLY_WITH_BYOT","CONFIG_MIGRATION_ONLY_WITH_BYOT_ON_FEDERATION","EDGE_CUTOVER","DFW_ONLY","DFW_WITH_BRIDGED_SEG","DFW_AND_HOST_AND_WORKLOAD","DFW_AND_HOST_AND_WORKLOAD_WITH_BRIDGED_SEG"],"readOnly":false,"type":"string"},"nsxt_site_to_avi_mappings":{"items":{"$ref":"#/definitions/NsxtSiteToAviMapping"},"readOnly":true,"type":"array","description":"List of mappings between NSX-T site and Avi. This will be populated only when the migration is executed on a cross VC setup.","title":"List of mappings between NSX-T site and Avi"},"esg_to_router_mapping_option":{"readOnly":true,"enum":["UI","FILE_UPLOAD","NO_MAPPING"],"type":"string","description":"Mapping option can be - - UI - FILE_UPLOAD - NO_MAPPING","title":"Mapping option"},"destination_nsx":{"$ref":"#/definitions/DestinationNsxApiEndpoint"},"nsxt_sites":{"items":{"$ref":"#/definitions/NsxtSite"},"readOnly":true,"type":"array","description":"Comprehensive information about NSX-T multi site setup. This will be populated only when the migration is executed on a cross VC setup.","title":"Comprehensive information about NSX-T Federation setup"},"source_nsx":{"items":{"$ref":"#/definitions/SourceNsxApiEndpoint"},"readOnly":false,"type":"array","description":"List of source NSX manager endpoints.","title":"List of source NSX managers"},"v2t_site_mappings":{"items":{"$ref":"#/definitions/V2tSiteMapping"},"readOnly":true,"type":"array","description":"List of site mappings between NSX-V and NSX-T. This will be populated only when the migration is executed on a cross VC setup.","title":"List of mappings between NSX-V and NSX-T sites"},"create_segment_ports":{"default":true,"readOnly":false,"type":"boolean","description":"Flag to indicate whether to create missing segment ports","title":"Flag to indicate whether to create missing segment ports"}},"title":"Details about source and destination NSX setup"},"LbJwtKey":{"description":"LbJwtKey specifies the symmetric key or asymmetric public key used to\ndecrypt the data in JWT.\n","title":"Load balancer JWT key","required":["type"],"discriminator":"type","x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"type":{"description":"The property is used to identify JWT key type.\n","enum":["LbJwtCertificateKey","LbJwtSymmetricKey","LbJwtPublicKey"],"type":"string"}}},"TraceResult":{"x-vmw-nsx-module":"LiveTrace","type":"object","properties":{"direction":{"readOnly":true,"enum":["FORWARD","BACKWARD"],"type":"string","description":"Direction of a trace","title":"Direction of a trace"},"logical_counters":{"$ref":"#/definitions/TraceflowObservationCounters"},"observations":{"items":{"$ref":"#/definitions/TraceflowObservation"},"readOnly":true,"type":"array","description":"Trace observation list","title":"Trace observation list"},"packet_id":{"readOnly":true,"type":"string","description":"Packet ID in the session","title":"Packet ID in the session"},"result_overflowed":{"readOnly":true,"type":"boolean","description":"Whether some observations were deleted from the result set","title":"Whether some observations were deleted from the result set"},"analysis":{"items":{"type":"string"},"readOnly":true,"type":"array","description":"Trace action result analysis notes","title":"Trace action result analysis notes"},"counters":{"$ref":"#/definitions/TraceflowObservationCounters"}}},"SystemHealthPluginProfile":{"x-vmw-nsx-module":"SystemHealthPlugin","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"SystemHealthPlugin","type":"object","properties":{"node_types":{"items":{"description":"Valid NSX node type","enum":["NSX_ESX","NSX_KVM","NSX_BAREMETAL_SERVER","NSX_EDGE","NSX_PUBLIC_CLOUD_GATEWAY","NSX_MANAGER","NSX_POLICY_MANAGER","NSX_CONTROLLER","GLOBAL_MANAGER"],"type":"string"},"readOnly":true,"type":"array","description":"Display the running node types of pre-defined plugin.\nThe config can be changed by API /systemhealth/profiles.\nTo see the effective status on given node, use the status API per node\n/systemhealth/plugins/status/.\n","title":"The supported node types"},"publisher":{"type":"string","description":"The publisher of System Health Agent plugin","title":"Plugin publisher"},"config":{"$ref":"#/definitions/SHAPredefinedPluginProfileData"},"enabled":{"readOnly":true,"type":"boolean","description":"Display the default on-off switch of pre defined plugin.\nThe config can be changed by API /systemhealth/profiles.\nTo see the effective status on given node, use the status API per node\n/systemhealth/plugins/status/.\n","title":"Plugin Enablement Flag"},"type":{"description":"The type of System Health Agent plugin","default":"NETWORK","enum":["COMPUTE","STORAGE","NETWORK","HYPERBUS","NCP","NODEAGENT","VSAN","TNAGENT","UPLINK"],"type":"string"}}}],"description":"Describes a profile to define a kind of system health plugin.\n","title":"System Health Plugin Profile"},"LogicalRouterPortListResult":{"x-vmw-nsx-module":"LogicalRouterPorts","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"LogicalRouterPorts","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/LogicalRouterPort"},"type":"array","description":"Logical router port list results","title":"Logical router port list results"}}}]},"IPSecVPNTunnelTrafficStatistics":{"x-vmw-nsx-module":"VPNStatistics","type":"object","description":"IPSec VPN tunnel traffic statistics.","properties":{"packets_sent_other_error":{"readOnly":true,"format":"int64","type":"integer","description":"Total number of packets dropped while sending for any reason.","title":"Packets sent other error"},"packets_out":{"readOnly":true,"format":"int64","type":"integer","description":"Total number of outgoing packets on outbound Security association (SA).","title":"Packets out"},"dropped_packets_out":{"readOnly":true,"format":"int64","type":"integer","description":"Total number of outgoing packets dropped on outbound security association.","title":"Dropped outgoing packets"},"integrity_failures":{"readOnly":true,"format":"int64","type":"integer","description":"Total number of packets dropped due to integrity failures.","title":"Integrity failures"},"nomatching_policy_errors":{"readOnly":true,"format":"int64","type":"integer","description":"Number of packets dropped because of no matching policy is available.","title":"Nomatching Policy errors"},"sa_mismatch_errors_in":{"readOnly":true,"format":"int64","type":"integer","description":"Totoal number of security association (SA) mismatch errors on incoming packets.","title":"Security association (SA) mismatch errors on incoming packets"},"peer_subnet":{"readOnly":true,"type":"string","description":"Peer subnet to which a tunnel belongs.","title":"Peer subnet"},"replay_errors":{"readOnly":true,"format":"int64","type":"integer","description":"Total number of packets dropped due to replay check on that Security association (SA).","title":"Replay errors"},"bytes_out":{"readOnly":true,"format":"int64","type":"integer","description":"Total number of outgoing bytes on outbound Security association (SA).","title":"Bytes out"},"local_subnet":{"readOnly":true,"type":"string","description":"Local subnet to which a tunnel belongs.","title":"Local subnet"},"dropped_packets_in":{"readOnly":true,"format":"int64","type":"integer","description":"Total number of incoming packets dropped on inbound security association.","title":"Dropped incoming packets"},"encryption_failures":{"readOnly":true,"format":"int64","type":"integer","description":"Total number of packets dropped because of failure in encryption.","title":"Encryption failures"},"sa_mismatch_errors_out":{"readOnly":true,"format":"int64","type":"integer","description":"Totoal number of security association (SA) mismatch errors on outgoing packets.","title":"Security association (SA) mismatch errors on outgoing packets"},"tunnel_down_reason":{"readOnly":true,"type":"string","description":"Gives the detailed reason about the tunnel when it is down. If tunnel is UP tunnel down reason will be empty.","title":"Tunnel down reason"},"packets_receive_other_error":{"readOnly":true,"format":"int64","type":"integer","description":"Total number of incoming packets dropped on inbound Security association (SA)(misc).","title":"Packets receive other error"},"bytes_in":{"readOnly":true,"format":"int64","type":"integer","description":"Total number of incoming bytes on inbound Security association (SA).","title":"Bytes in"},"decryption_failures":{"readOnly":true,"format":"int64","type":"integer","description":"Total number of packets dropped due to decryption failures.","title":"Decryption failures"},"seq_number_overflow_error":{"readOnly":true,"format":"int64","type":"integer","description":"Total number of packets dropped while sending due to overflow in sequence number.","title":"Sequence number overflow error"},"packets_in":{"readOnly":true,"format":"int64","type":"integer","description":"Total number of incoming packets on inbound Security association (SA).","title":"Packets in"},"tunnel_status":{"readOnly":true,"enum":["UP","DOWN","NEGOTIATING"],"type":"string","description":"Specifies the status of tunnel. If all the SA (Security association) are negotiated then tunnels status will be UP. If negotiation fails for the SAs status will be DOWN, if SAs are in negotiating phase tunnels status will be NEGOTIATING.","title":"Tunnel Status"},"policy_id":{"readOnly":true,"type":"string","description":"Policy UUID of IPSec Tunnel.","title":"Policy Identifier"}},"title":"IPSec VPN tunnel traffic statistics"},"AuthenticationScheme":{"x-vmw-nsx-module":"MISSING_MODULE","required":["scheme_name"],"type":"object","properties":{"scheme_name":{"type":"string","description":"Authentication scheme name","title":"Authentication scheme name"}}},"MigrationUnitAggregateInfoListResult":{"x-vmw-nsx-module":"Migration","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"Migration","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/MigrationUnitAggregateInfo"},"readOnly":true,"type":"array","description":"Paged collection of MigrationUnit AggregateInfo","title":"Paged collection of MigrationUnit AggregateInfo"}}}]},"LbServiceInstanceDetailPerTransportNode":{"x-vmw-nsx-module":"AggSvcLb","type":"object","properties":{"instance_detail_per_status":{"items":{"$ref":"#/definitions/LbServiceInstanceDetailPerStatus"},"type":"array","description":"Load balancer instances details for each load balancer instance\nstatus type from the given transport node.\n","title":"Load balancer instances details for each status"},"transport_node_id":{"type":"string","description":"The UUID of the transport node.\n","title":"The UUID of the transport node"}}},"TransportZoneStatus":{"x-vmw-nsx-module":"TransportZone","type":"object","description":"Transport zone runtime status information","properties":{"num_logical_ports":{"readOnly":true,"format":"int32","type":"integer","description":"Count of logical ports in the transport zone","title":"Count of logical ports in the transport zone"},"transport_zone_id":{"readOnly":true,"type":"string","description":"Unique ID identifying the transport zone","title":"Unique ID identifying the transport zone"},"transport_node_members":{"items":{"$ref":"#/definitions/TransportNodeMemberInfo"},"readOnly":true,"type":"array","description":"Information about transport nodes which are part of this transport zone","title":"Information about transport nodes which are part of this transport zone"},"num_logical_switches":{"readOnly":true,"format":"int32","type":"integer","description":"Count of logical switches in the transport zone","title":"Count of logical switches in the transport zone"},"num_transport_nodes":{"readOnly":true,"format":"int32","type":"integer","description":"Count of transport nodes in the transport zone","title":"Count of transport nodes in the transport zone"}},"title":"Transport zone runtime status information"},"LbCookiePersistenceProfile":{"x-vmw-nsx-module":"LoadBalancer","description":"The object is deprecated as NSX-T Load Balancer is deprecated.\n","allOf":[{"$ref":"#/definitions/LbPersistenceProfile"},{"x-vmw-nsx-module":"LoadBalancer","required":["cookie_name"],"type":"object","properties":{"cookie_garble":{"default":true,"type":"boolean","description":"If garble is set to true, cookie value (server IP and port) would be\nencrypted.\nIf garble is set to false, cookie value would be plain text.\n","title":"cookie persistence garble"},"cookie_secure":{"default":false,"type":"boolean","description":"If cookie secure flag is true, it prevents the browser from sending a\ncookie over http. The cookie is sent only over https. Only\navailable for insert mode.\n","title":"Cookie secure flag"},"cookie_fallback":{"default":true,"type":"boolean","description":"If fallback is true, once the cookie points to a server that is down\n(i.e. admin state DISABLED or healthcheck state is DOWN), then a new\nserver is selected by default to handle that request.\nIf fallback is false, it will cause the request to be rejected if\ncookie points to a server\n","title":"cookie persistence fallback"},"cookie_mode":{"description":"cookie persistence mode","default":"INSERT","enum":["INSERT","PREFIX","REWRITE"],"type":"string"},"cookie_domain":{"type":"string","description":"HTTP cookie domain could be configured, only available for insert mode.\n","title":"cookie domain"},"cookie_httponly":{"default":false,"type":"boolean","description":"If cookie httponly flag is true, it prevents a script running in the\nbrowser from accessing the cookie. Only available for insert mode.\n","title":"Cookie httponly flag"},"cookie_name":{"type":"string","description":"cookie name","title":"cookie name"},"cookie_time":{"$ref":"#/definitions/LbCookieTime"},"cookie_path":{"type":"string","description":"HTTP cookie path could be set, only available for insert mode.\n","title":"cookie path"}}}]},"RemoteBundleUrl":{"description":"URL of remote bundle which needs to be uploaded.","title":"URL of remote bundle","required":["url"],"x-vmw-nsx-module":"FileUploadFramework","type":"object","properties":{"url":{"readOnly":false,"type":"string","description":"URL for uploading remote bundle","title":"URL of remote bundle"}}},"FileProperties":{"x-vmw-nsx-module":"MISSING_MODULE","allOf":[{"$ref":"#/definitions/Resource"},{"required":["created_epoch_ms","modified_epoch_ms","name","size"],"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"created_epoch_ms":{"format":"int64","type":"integer","description":"File creation time in epoch milliseconds","title":"File creation time in epoch milliseconds"},"modified_epoch_ms":{"format":"int64","type":"integer","description":"File modification time in epoch milliseconds","title":"File modification time in epoch milliseconds"},"name":{"type":"string","description":"File name","title":"File name"},"size":{"format":"int64","type":"integer","description":"Size of the file in bytes","title":"Size of the file in bytes"}}}],"description":"File properties","title":"File properties"},"AddClusterNodeSpec":{"x-vmw-nsx-module":"ClusterManagement","type":"object","properties":{"external_id":{"readOnly":false,"type":"string","description":"External identifier of the node","title":"External identifier of the node"},"controller_role_config":{"$ref":"#/definitions/AddControllerNodeSpec"},"display_name":{"type":"string","description":"Display name for the node","title":"Display name for the node"},"mgr_role_config":{"$ref":"#/definitions/AddManagementNodeSpec"}}},"IpfixCollectorConfig":{"x-vmw-nsx-module":"Ipfix","description":"This managed entity contains a set of IPFIX collectors.\n","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"Ipfix","required":["collectors"],"type":"object","properties":{"collectors":{"description":"IPFIX Collectors","title":"IPFIX Collectors","minItems":1,"items":{"$ref":"#/definitions/IpfixCollector"},"maxItems":4,"type":"array"}}}]},"TraceflowObservationReceivedLogical":{"x-vmw-nsx-module":"Traceflow","allOf":[{"$ref":"#/definitions/TraceflowObservation"},{"x-vmw-nsx-module":"Traceflow","type":"object","properties":{"svc_mac":{"readOnly":true,"type":"string","description":"MAC address of SAN volume controller for service insertion(SI)\nin service VM(SVM) where the traceflow packet was received.\n","title":"MAC address of SAN volume controller"},"src_component_id":{"readOnly":true,"type":"string","description":"The id of the source component from which the traceflow packet was received.","title":"The id of the source component from which the traceflow packet was received."},"component_id":{"readOnly":true,"type":"string","description":"The id of the component that received the traceflow packet.","title":"The id of the component that received the traceflow packet."},"lport_id":{"readOnly":true,"type":"string","description":"The id of the logical port at which the traceflow packet was received","title":"The id of the logical port at which the traceflow packet was received"},"src_component_type":{"description":"The type of the source component from which the traceflow packet was received.","enum":["PHYSICAL","LR","LS","DFW","BRIDGE","EDGE_TUNNEL","EDGE_HOSTSWITCH","FW_BRIDGE","EDGE_RTEP_TUNNEL","LOAD_BALANCER","NAT","IPSEC","SERVICE_INSERTION","VMC","SPOOFGUARD","EDGE_FW","DLB","ANTREA_SPOOFGUARD","ANTREA_LB","ANTREA_ROUTING","ANTREA_DFW","ANTREA_FORWARDING","HOST_SWITCH","UNKNOWN"],"readOnly":true,"type":"string"},"lport_name":{"readOnly":true,"type":"string","description":"The name of the logical port at which the traceflow packet was received","title":"The name of the logical port at which the traceflow packet was received"},"vlan":{"description":"This field is specified when the traceflow packet was received by a VLAN\nlogical network.\n","format":"int64","readOnly":true,"type":"integer"},"src_component_name":{"readOnly":true,"type":"string","description":"The name of source component from which the traceflow packet was received.","title":"The name of source component from which the traceflow packet was received."},"vni":{"readOnly":true,"format":"int32","type":"integer","description":"This field is specified when the traceflow packet was received by an overlay\nlogical network.\n","title":"VNI for the logical network on which the traceflow packet was received."}}}]},"NSServiceGroupListResult":{"x-vmw-nsx-module":"NSServiceGroup","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"NSServiceGroup","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/NSServiceGroup"},"type":"array","description":"Paged collection of NSServiceGroups","title":"Paged collection of NSServiceGroups"}}}],"description":"List result of NSServiceGroups","title":"List result of NSServiceGroups"},"Principal":{"x-vmw-nsx-module":"CertificateManager","required":["attributes"],"type":"object","properties":{"attributes":{"items":{"$ref":"#/definitions/KeyValue"},"readOnly":false,"type":"array","description":"Attribute list."}}},"DhcpV6StaticBindingListResult":{"x-vmw-nsx-module":"Dhcp","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"Dhcp","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/DhcpV6StaticBinding"},"type":"array","description":"A paginated list of DHCP IPv6 static bindings.","title":"Paginated list of DHCP IPv6 static bindings"}}}],"description":"A paginated list of DHCP IPv6 static bindings.","title":"A list of DHCP IPv6 static bindings"},"ContainerProjectListResult":{"x-vmw-nsx-module":"InventoryContainerObj","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"InventoryContainerObj","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/ContainerProject"},"type":"array","description":"List of projects","title":"List of projects"}}}]},"Role":{"description":"Role","title":"Role","required":["role"],"x-vmw-nsx-module":"AAA","type":"object","properties":{"role":{"type":"string","description":"Short identifier for the role. Must be all lower case with no spaces.","title":"Role identifier"},"role_display_name":{"type":"string","description":"A short, human-friendly display name of the role.","title":"Display name for role"}}},"ServiceDeploymentStatus":{"x-vmw-nsx-module":"ServiceInsertionVMDeployment","type":"object","properties":{"deployment_issues":{"items":{"$ref":"#/definitions/ServiceDeploymentIssue"},"readOnly":true,"type":"array","description":"List of issue and detailed description of the issue in case of deployment failure.","title":"Service deployment issue"},"last_update_timestamp":{"description":"Timestamp when the data was last updated; unset if data source has never updated the data.","format":"int64","readOnly":true,"type":"integer"},"deployment_status":{"readOnly":true,"enum":["UPGRADE_IN_PROGRESS","UPGRADE_FAILED","DEPLOYMENT_QUEUED","DEPLOYMENT_IN_PROGRESS","DEPLOYMENT_FAILED","DEPLOYMENT_SUCCESSFUL","UNDEPLOYMENT_QUEUED","UNDEPLOYMENT_IN_PROGRESS","UNDEPLOYMENT_FAILED","UNDEPLOYMENT_SUCCESSFUL","UPGRADE_QUEUED"],"type":"string","description":"Deployment status of NXGI Partner Service-VM on a compute collection. It shows the latest status during the process of deployment, redeploy, upgrade, and un-deployment on a compute collection such as VC cluster.","title":"Compute collection deployment progress status"},"sva_current_version":{"type":"string","description":"Currently deployed Service Virtual Appliance version.","title":"Current deployed SVA version"},"service_deployment_id":{"readOnly":true,"type":"string","description":"Id of service deployment.","title":"Service deployment id"},"sva_max_available_version":{"type":"string","description":"Max available SVA version for upgrade","title":"Max available SVA version"}}},"CertificateProfile":{"x-vmw-nsx-module":"CertificateManager","allOf":[{"$ref":"#/definitions/Resource"},{"x-vmw-nsx-module":"CertificateManager","type":"object","properties":{"cluster_certificate":{"readOnly":true,"type":"boolean","description":"True if this is for a cluster certificate","title":"Cluster Certificate"},"node_type":{"items":{"type":"string","description":"Node Type"},"readOnly":true,"type":"array","description":"List of types of node this certificate applies to.","title":"Node Type"},"profile_name":{"readOnly":true,"type":"string","description":"Certificate Profile Name","title":"Certificate Profile Name"},"extended_key_usage":{"items":{"description":"Usage Type of the Certificate, SERVER or CLIENT. Default is SERVER","enum":["SERVER","CLIENT"],"type":"string"},"readOnly":true,"type":"array","description":"Indicating whether this certificate is used for server-auth, client-auth or both.","title":"Extended Key Usage"},"service_type":{"description":"Unique Service Type","enum":["MGMT_CLUSTER","MGMT_PLANE","API","NOTIFICATION_COLLECTOR","SYSLOG_SERVER","RSYSLOG_CLIENT","APH","GLOBAL_MANAGER","LOCAL_MANAGER","CLIENT_AUTH","RMQ","K8S_MSG_CLIENT"],"readOnly":true,"type":"string"},"unique_use":{"readOnly":true,"type":"boolean","description":"True if the certificate used for this service-type cannot be used anywhere else.","title":"Unique Use"}}}]},"InstanceEndpoint":{"x-vmw-nsx-module":"ServiceInsertionCommonTypes","allOf":[{"$ref":"#/definitions/ManagedResource"},{"required":["target_ips"],"x-vmw-nsx-module":"ServiceInsertionCommonTypes","type":"object","properties":{"service_attachments":{"description":"Id(s) of the Service Attachment where this enndpoint is connected to. Service Attachment is mandatory for LOGICAL Instance Endpoint.","title":"Service Attachment list","minItems":1,"items":{"$ref":"#/definitions/ResourceReference"},"readOnly":false,"maxItems":1,"type":"array"},"target_ips":{"description":"Target IPs on an interface of the Service Instance.","title":"Target IPs","minItems":1,"items":{"$ref":"#/definitions/IPInfo"},"maxItems":1,"type":"array"},"endpoint_type":{"description":"LOGICAL - It must be created with a ServiceAttachment and identifies a destination connected to the Service Port of the ServiceAttachment, through the ServiceAttachment's Logical Switch. VIRTUAL - It represents a L3 destination the router can route to but does not provide any further information about its location in the network. Virtual InstanceEndpoints are used for redirection targets that are not connected to Service Ports, such as the next-hop routers on the Edge uplinks.","title":"Instance Endpoint Type","default":"LOGICAL","enum":["LOGICAL","VIRTUAL"],"readOnly":false,"type":"string"},"service_instance_id":{"readOnly":true,"type":"string","description":"The Service instancee with which the instance endpoint is associated.","title":"Service instance Id"},"link_ids":{"description":"Link Ids are mandatory for VIRTUAL Instance Endpoint. Even though VIRTUAL, the Instance Endpoint should be connected/accessible through an NSX object. The link id is this NSX object id. Example - For North-South Service Insertion, this is the LogicalRouter Id through which the targetIp/L3 destination accessible.","title":"Link Id list","minItems":1,"items":{"$ref":"#/definitions/ResourceReference"},"readOnly":false,"maxItems":1,"type":"array"}}}],"description":"An InstanceEndpoint belongs to one ServiceInstance and represents a redirection target for a Rule. For Example - It can be an L3 Destination. Service Attachments is required for a InstanceEndpoint of type LOGICAL, and deployed_to if its a VIRTUAL InstanceEndpoint.","title":"EndPoint of an Instance"},"PublicCloudGatewayNode":{"x-vmw-nsx-module":"FabricNode","allOf":[{"$ref":"#/definitions/EdgeNode"},{"x-vmw-nsx-module":"FabricNode","type":"object"}]},"LoginCredential":{"description":"Base type for various login credential types","title":"Base type for various login credential types","required":["credential_type"],"discriminator":"credential_type","x-vmw-nsx-module":"Types","type":"object","properties":{"credential_type":{"type":"string","description":"Possible values are 'UsernamePasswordLoginCredential', 'VerifiableAsymmetricLoginCredential', 'SessionLoginCredential'.","title":"Login credential, for example username-password-thumbprint, certificate or session based, etc"}}},"MemoryReservation":{"x-vmw-nsx-module":"FabricNode","type":"object","description":"Relative to the form factor pre-defined reservation value. To reduce\nreservation of a VM to 50 percent, a user may specify 50 instead of the\nabsolute number relevant for the edge form factor.\n","properties":{"reservation_percentage":{"description":"Memory reserved relative to the default reservation of 100 percent.\nFor example, take an edge virtual machine of medium form factor.\nBy default, an edge of medium form factor is configured with 8 GB of\nmemory and with reservation of 100 percent. So, 8 GB of memory is\nreserved. If you specify reservation_percentage value as 50 percent,\nthen 4 GB of memory will be reserved.\n","title":"Memory reservation percentage.","default":100,"format":"int32","maximum":100,"minimum":0,"type":"integer"}}},"OidcEndPoint":{"x-vmw-nsx-module":"CertificateManager","allOf":[{"$ref":"#/definitions/ManagedResource"},{"required":["oidc_uri","thumbprint"],"x-vmw-nsx-module":"CertificateManager","type":"object","properties":{"userinfo_endpoint":{"readOnly":true,"type":"string","description":"The URL of the OpenID provider's userinfo endpoint.","title":"Userinfo endpoint"},"claims_supported":{"items":{"type":"string"},"readOnly":true,"type":"array","description":"The list of claims that the OpenID provider supports.","title":"Claims supported"},"name":{"type":"string","description":"A short, unique name for this OpenID Connect end-point. OIDC endpoint names may not contain spaces. If not provided, defaults to the ID of the OidcEndPoint.","title":"Unique name for this OpenID Connect end-point"},"oidc_type":{"description":"Type used to distinguish the OIDC end-points by IDP.","title":"OIDC Type","default":"vcenter","enum":["vcenter","ws_one"],"readOnly":false,"maxLength":255,"type":"string"},"oidc_uri":{"readOnly":false,"maxLength":255,"type":"string","description":"URI of the OpenID Connect end-point.","title":"OpenID Connect URI"},"token_endpoint":{"readOnly":true,"type":"string","description":"The URL of the OpenID provider's token endpoint.","title":"Token endpoint"},"thumbprint":{"readOnly":false,"maxLength":255,"type":"string","description":"Thumbprint in SHA-256 format used to verify the server certificate at the URI.\n","title":"Thumbprint"},"jwks_uri":{"readOnly":true,"type":"string","description":"The URI where the JWKS document is located that has the key used to validate the JWT signature.\n","title":"URI of JWKS document"},"authorization_endpoint":{"readOnly":true,"type":"string","description":"The URL of the OpenID provider's authorization endpoint.","title":"Authorization endpoint"},"override_roles":{"items":{"type":"string"},"readOnly":true,"type":"array","description":"When specified this role or roles are used instead of the nsx-role in the JWT","title":"Roles used instead of token roles"},"issuer":{"readOnly":true,"type":"string","description":"Issuer of the JWT tokens for the given type. This field is fetched from the meta-data located at the oidc_uri.\n","title":"JWT token issuer"}}}],"description":"OpenID Connect end-point specifying where to fetch the JWKS document used to\nvalidate JWT tokens for TokenBasedPrincipalIdentities.\n","title":"OpenID Connect end-point"},"LogicalPortStatistics":{"x-vmw-nsx-module":"AggSvcLogicalPort","allOf":[{"$ref":"#/definitions/AggregatedDataCounterEx"},{"x-vmw-nsx-module":"AggSvcLogicalPort","type":"object","properties":{"logical_port_id":{"readOnly":true,"type":"string","description":"The id of the logical port","title":"The id of the logical port"},"last_update_timestamp":{"description":"Timestamp when the data was last updated; unset if data source has never updated the data.","format":"int64","readOnly":true,"type":"integer"}}}]},"IpPoolRange":{"x-vmw-nsx-module":"Ipam","description":"A set of IPv4 or IPv6 addresses defined by a start and end address.","allOf":[{"$ref":"#/definitions/Resource"},{"x-vmw-nsx-module":"Ipam","required":["start","end"],"type":"object","properties":{"start":{"description":"The start IP Address of the IP Range.","format":"ip","type":"string"},"end":{"description":"The end IP Address of the IP Range.","format":"ip","type":"string"}}}]},"AggregatedLogicalRouterPortCounters":{"x-vmw-nsx-module":"AggSvcLogicalRouterPort","type":"object","properties":{"last_update_timestamp":{"description":"Timestamp when the data was last updated; unset if data source has never updated the data.","format":"int64","readOnly":true,"type":"integer"},"rx":{"$ref":"#/definitions/LogicalRouterPortCounters"},"tx":{"$ref":"#/definitions/LogicalRouterPortCounters"}}},"ServicePath":{"x-vmw-nsx-module":"ServiceInsertionCommonTypes","type":"object","description":"An instance of service chain that consists of forward and reverse service paths.","properties":{"reverse_path":{"$ref":"#/definitions/UnidirectionalServicePath"},"service_chain_uuid":{"readOnly":true,"type":"string","description":"Uuid of a service chain.","title":"Uuid of a service chain"},"forward_path":{"$ref":"#/definitions/UnidirectionalServicePath"},"service_path_id":{"readOnly":true,"format":"int64","type":"integer","description":"Unique identifier of a service path.","title":"Service path id"},"service_chain_id":{"readOnly":true,"format":"int64","type":"integer","description":"A unique id of a service chain.","title":"Service chain id"}},"title":"Service path"},"SIExcludeList":{"x-vmw-nsx-module":"ServiceInsertionExcludeList","allOf":[{"$ref":"#/definitions/DSExcludeList"},{"x-vmw-nsx-module":"ServiceInsertionExcludeList","type":"object"}],"description":"List of entities where Service Insertion will not be enforced. Exclusion List can contain NSGroup(s) or LogicalPort(s) or LogicalSwitch(es).","title":"Exclusion List"},"EffectiveIPAddressMemberListResult":{"x-vmw-nsx-module":"NSGroup","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"NSGroup","required":["results"],"type":"object","properties":{"results":{"items":{"description":"IPElement can be a single IP address, IP address range or a Subnet. Its\ntype can be of IPv4 or IPv6. Supported list of formats are \"192.168.1.1\",\n\"192.168.1.1-192.168.1.100\", \"192.168.0.0/24\",\n\"fe80::250:56ff:fe83:318c\",\n\"fe80::250:56ff:fe83:3181-fe80::250:56ff:fe83:318c\",\n\"fe80::250:56ff:fe83:318c/64\"\n","format":"address-or-block-or-range","type":"string"},"type":"array","description":"Paged Collection of effective ip addresses for the given NSGroup","title":"Paged Collection of effective ip addresses for the given NSGroup"}}}]},"SwitchingGlobalConfig":{"x-vmw-nsx-module":"GlobalConfigs","allOf":[{"$ref":"#/definitions/GlobalConfigs"},{"x-vmw-nsx-module":"GlobalConfigs","type":"object","properties":{"arp_limit_per_lr":{"description":"This is a global max ARP limit per logical router per transport\nnode. It is applied to all the logical routers present on all types\nof transport nodes in the NSX domain. Updates to the field are\nallowed only through /policy/api/v1/infra/global-config API.\n","title":"ARP limit per logical router per transport node","default":50000,"format":"int32","maximum":50000,"minimum":5000,"type":"integer"},"global_replication_mode_enabled":{"default":false,"type":"boolean","description":"When this flag is set true, certain types of BUM packets will be sent to all VTEPs in the global VTEP table, ignoring the logical switching span.","title":"A flag to indicate if global replication mode is enabled"},"uplink_mtu_threshold":{"description":"This value defines the upper threshold for the MTU value that can be configured at a physical uplink level or a logical routing uplink level in a NSX domain. All Uplink profiles validate against this value so that the MTU specified in an Uplink profile does not exceed this global upper threshold. Similarly, when this value is modified, the new value must be greater than or equal to any existing Uplink profile's MTU. This value is also validated to be greater than or equal to physical_uplink_mtu in SwitchingGlobalConfig and logical_uplink_mtu in RoutingGlobalConfig.","format":"int32","default":9000,"title":"Upper threshold for MTU on physical and logical uplinks","readOnly":false,"type":"integer"},"remote_tunnel_physical_mtu":{"description":"This is the global default MTU for all the physical remote tunnel endpoints in an NSX domain. Please consider intersite link MTU minus any external overhead when defining the MTU. If this value is not set, the default value of 1500 will be used.","format":"int32","default":1700,"title":"The physical MTU for the remote tunnel endpoints","readOnly":false,"type":"integer"},"physical_uplink_mtu":{"description":"This is the global default MTU for all the physical uplinks in a NSX domain. This is the default value for the optional uplink profile MTU field. When the MTU value is not specified in the uplink profile, this global value will be used. This value can be overridden by providing a value for the optional MTU field in the uplink profile. Whenever this value is updated, the updated value will only be propagated to the uplinks that don't have the MTU value in their uplink profiles. If this value is not set, the default value of 1700 will be used. The Transport Node state can be monitored to confirm if the updated MTU value has been realized.","format":"int32","default":1700,"title":"MTU for the physical uplinks","readOnly":false,"type":"integer"}}}],"description":"NSX global configs for switching","title":"NSX global configs for switching"},"ServerSslProfileBinding":{"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"server_auth_crl_ids":{"items":{"type":"string"},"type":"array","description":"A Certificate Revocation List (CRL) can be specified in the server-side\nSSL profile binding to disallow compromised server certificates.\n","title":"CRL identifier list to verify server certificate"},"server_auth":{"description":"server authentication mode","default":"IGNORE","enum":["REQUIRED","IGNORE"],"type":"string"},"certificate_chain_depth":{"description":"authentication depth is used to set the verification depth in the server\ncertificates chain.\n","title":"the maximum traversal depth of server certificate chain","default":3,"format":"int64","maximum":2147483647,"minimum":1,"type":"integer"},"client_certificate_id":{"type":"string","description":"To support client authentication (load balancer acting as a client\nauthenticating to the backend server), client certificate can be\nspecified in the server-side SSL profile binding\n","title":"client certificate identifier"},"server_auth_ca_ids":{"items":{"type":"string"},"type":"array","description":"If server auth type is REQUIRED, server certificate must be signed by\none of the trusted Certificate Authorities (CAs), also referred to as\nroot CAs, whose self signed certificates are specified.\n","title":"CA identifier list to verify server certificate"},"ssl_profile_id":{"type":"string","description":"Server SSL profile defines reusable, application-independent server side\nSSL properties.\n","title":"server SSL profile identifier"}}},"ServiceDeployment":{"x-vmw-nsx-module":"ServiceInsertionCommonTypes","allOf":[{"$ref":"#/definitions/ManagedResource"},{"required":["deployment_spec_name","instance_deployment_template","service_deployment_config"],"x-vmw-nsx-module":"ServiceInsertionCommonTypes","type":"object","properties":{"perimeter":{"description":"This indicates the deployment perimeter, such as a VC cluster or a host.","title":"Deployment perimeter","default":"HOST","enum":["CLUSTER","HOST"],"readOnly":false,"type":"string"},"deployment_spec_name":{"readOnly":false,"type":"string","description":"Name of the deployment spec to be used for deployment, which specifies the OVF provided by the partner and the form factor.","title":"Deployment Spec Name"},"deployment_mode":{"description":"Mode of deployment. Currently, only stand alone deployment is supported. It is a single VM deployed through this deployment spec. In future, HA configurations will be supported here.","title":"Deployment Mode","default":"STAND_ALONE","enum":["STAND_ALONE","ACTIVE_STANDBY"],"readOnly":false,"type":"string"},"instance_deployment_template":{"$ref":"#/definitions/DeploymentTemplate"},"service_deployment_config":{"$ref":"#/definitions/ServiceDeploymentConfig"},"service_id":{"readOnly":true,"type":"string","description":"The Service to which the service deployment is associated.","title":"Service Id"},"clustered_deployment_count":{"description":"Number of instances in case of clustered deployment.","title":"Clustered Deployment Count","default":1,"format":"int64","maximum":10,"readOnly":false,"minimum":1,"type":"integer"},"deployed_to":{"description":"List of resource references where service instance be deployed. Ex. Tier 0 Logical Router in case of N-S ServiceInsertion. Service Attachment in case of E-W ServiceInsertion.","title":"Deployed-to object list","minItems":1,"items":{"$ref":"#/definitions/ResourceReference"},"readOnly":false,"maxItems":128,"type":"array"},"deployment_type":{"description":"Specifies whether the service VM should be deployed on each host such that it provides partner service locally on the host, or whether the service VMs can be deployed as a cluster. If deployment_type is CLUSTERED, then the clustered_deployment_count should be provided.","title":"Deployment Type","default":"CLUSTERED","enum":["HOSTLOCAL","CLUSTERED"],"readOnly":false,"type":"string"}}}],"description":"Used to provide the deployment specification for the service.","title":"Deployment details of a Service"},"FieldsPacketData":{"x-vmw-nsx-module":"Traceflow","allOf":[{"$ref":"#/definitions/PacketData"},{"x-vmw-nsx-module":"Traceflow","type":"object","properties":{"ipv6_header":{"$ref":"#/definitions/Ipv6Header"},"arp_header":{"$ref":"#/definitions/ArpHeader"},"transport_header":{"$ref":"#/definitions/TransportProtocolHeader"},"ip_header":{"$ref":"#/definitions/Ipv4Header"},"eth_header":{"$ref":"#/definitions/EthernetHeader"},"payload":{"maxLength":1336,"type":"string","description":"Up to 1000 bytes of payload may be supplied (with a base64-encoded length of 1336 bytes.) Additional bytes of traceflow metadata will be appended to the payload. The payload contains any data the user wants to put after the transport header.","title":"RFC3548 compatible base64-encoded payload"}}}]},"PasswordAuthenticationScheme":{"x-vmw-nsx-module":"MISSING_MODULE","allOf":[{"$ref":"#/definitions/AuthenticationScheme"},{"x-vmw-nsx-module":"MISSING_MODULE","required":["username","scheme_name"],"type":"object","properties":{"username":{"type":"string","description":"User name to authenticate with","title":"User name to authenticate with"},"scheme_name":{"enum":["password"],"type":"string","description":"Authentication scheme name","title":"Authentication scheme name"},"password":{"type":"string","description":"Password to authenticate with","title":"Password to authenticate with"}}}]},"LogicalRouterCentralizedServicePort":{"x-vmw-nsx-module":"LogicalRouterPorts","allOf":[{"$ref":"#/definitions/LogicalRouterPort"},{"x-vmw-nsx-module":"LogicalRouterPorts","type":"object","properties":{"linked_logical_switch_port_id":{"$ref":"#/definitions/ResourceReference"},"subnets":{"minItems":1,"items":{"$ref":"#/definitions/IPSubnet"},"type":"array","description":"Logical router port subnets","title":"Logical router port subnets"},"enable_netx":{"default":false,"type":"boolean","description":"Port is exclusively used for N-S service insertion","title":"Port is exclusively used for N-S service insertion"},"urpf_mode":{"description":"Unicast Reverse Path Forwarding mode","default":"STRICT","enum":["NONE","STRICT"],"type":"string"},"ndra_profile_id":{"type":"string","description":"Identifier of Neighbor Discovery Router Advertisement profile\nassociated with port. When NDRA profile id is associated at\nboth the port level and logical router level, the profile id\nspecified at port level takes the precedence.\n","title":"Identifier for NDRA profile on the port"},"mtu":{"format":"int64","minimum":64,"type":"integer","description":"Maximum transmission unit specifies the size of the largest packet that\na network protocol can transmit. If not specified, the global logical\nMTU set in the /api/v1/global-configs/RoutingGlobalConfig API will be\nused.\n","title":"Maximum transmission unit (MTU)"}}}],"description":"This port can be configured on both TIER0 and TIER1 logical router.\nPort can be connected to VLAN or overlay logical switch.\nUnlike downlink port it does not participate in distributed routing and\nhosted on all edge cluster members associated with logical router.\nStateful services can be applied on this port.\n","title":"Port to connect VLAN based network or overlay logical switch"},"ServiceChainListResult":{"x-vmw-nsx-module":"ServiceInsertion","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"ServiceInsertion","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/ServiceChain"},"readOnly":true,"type":"array","description":"List of the Service-Insertion Services. The list has to be homogenous.","title":"Service list"}}}],"description":"Service Chain List","title":"Service Chain List"},"RealizationStateBarrierConfig":{"x-vmw-nsx-module":"RealizationStateBarrier","description":"The configuration data for setting the global realization state barrier\n","allOf":[{"$ref":"#/definitions/RevisionedResource"},{"x-vmw-nsx-module":"RealizationStateBarrier","required":["interval"],"type":"object","properties":{"interval":{"description":"The interval in milliseconds used for auto incrementing the barrier number\n","format":"int64","title":"Interval in milliseconds","readOnly":false,"minimum":0,"type":"integer"}}}]},"PointDefinition":{"description":"Defines the point of a graph.","title":"Definition of a point of graph","required":["y_value","x_value","field"],"x-vmw-nsx-module":"NsxDashboard","type":"object","properties":{"y_value":{"type":"string","description":"Represents the variable for the Y value of points that are plotted on the graph.","title":"Variable chosen for Y value of the point of the graph"},"field":{"type":"string","description":"An expression that represents the points of the graph","title":"Expression for points of the graph"},"drilldown_id":{"type":"string","description":"Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget.","title":"Id of drilldown widget"},"x_value":{"type":"string","description":"Represents the variable for the X value of points that are plotted on the graph.","title":"Variable chosen for X value of the point of the graph"},"navigation":{"maxLength":1024,"type":"string","description":"Hyperlink of the specified UI page that provides details.","title":"Navigation to a specified UI page"},"tooltip":{"minItems":0,"items":{"$ref":"#/definitions/Tooltip"},"type":"array","description":"Multi-line text to be shown on tooltip while hovering over the point of a graph.","title":"Multi-line tooltip"}}},"GraphDefinition":{"description":"Defines a graph","title":"Definition of a graph","required":["point_definition"],"x-vmw-nsx-module":"NsxDashboard","type":"object","properties":{"row_list_field":{"type":"string","description":"An expression that represents the series of the graph","title":"Expression for series of the graph"},"point_definition":{"$ref":"#/definitions/PointDefinition"},"label":{"$ref":"#/definitions/Label"},"id":{"type":"string","description":"Identifier of graph. It can be used to differentiate multiple graph series present in GraphWidgetConfiguration.","title":"Identifier of graph"},"render_configuration":{"minItems":0,"items":{"$ref":"#/definitions/RenderConfiguration"},"type":"array","description":"Additional rendering or conditional evaluation of the field values to be performed, if any.","title":"Render Configuration"}}},"PktCapResult":{"x-vmw-nsx-module":"LiveTrace","type":"object","description":"The packet capture result for transport nodes\n","properties":{"pktcap_resource_list":{"items":{"$ref":"#/definitions/PktCapResource"},"readOnly":true,"type":"array","description":"The packet capture resource info for ports where packet\ncapture action is performed\n","title":"Packet capture results on the given transport node"},"transport_node_type":{"description":"Type of the transport node","enum":["ESX","RHELKVM","UBUNTUKVM","CENTOSKVM","RHELCONTAINER","CENTOSCONTAINER","RHELSERVER","UBUNTUSERVER","CENTOSSERVER","SLESKVM","SLESSERVER","WINDOWSSERVER","RHELSMARTNIC","OELSERVER","UBUNTUSMARTNIC","EDGE","PUBLIC_CLOUD_GATEWAY_NODE","OTHERS","HYPERV"],"readOnly":true,"type":"string"},"transport_node_id":{"readOnly":true,"type":"string","description":"The ID of transport node where packet capture action is deployed","title":"The ID of transport node where packet capture action is deployed"}}},"TraceflowObservationDelivered":{"x-vmw-nsx-module":"Traceflow","allOf":[{"$ref":"#/definitions/TraceflowObservation"},{"x-vmw-nsx-module":"Traceflow","type":"object","properties":{"resolution_type":{"readOnly":true,"enum":["UNKNOWN","ARP_SUPPRESSION_PORT_CACHE","ARP_SUPPRESSION_TABLE","ARP_SUPPRESSION_CP_QUERY","ARP_VM"],"type":"string","description":"This field specifies the resolution type of ARP ARP_SUPPRESSION_PORT_CACHE - ARP request is suppressed by port DB ARP_SUPPRESSION_TABLE - ARP request is suppressed by ARP table ARP_SUPPRESSION_CP_QUERY - ARP request is suppressed by info derived from CP ARP_VM - No suppression and the ARP request is resolved.","title":"The resolution type of the delivered message for ARP"},"lport_name":{"readOnly":true,"type":"string","description":"The name of the logical port into which the traceflow packet was delivered","title":"The name of the logical port into which the traceflow packet was delivered"},"target_mac":{"readOnly":true,"type":"string","description":"The source MAC address of form:\n\"^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$\". For example: 00:00:00:00:00:00.\n","title":"MAC address of the resolved IP by ARP"},"vlan_id":{"type":"integer","description":"VLAN on bridged network","format":"int64"},"lport_id":{"readOnly":true,"type":"string","description":"The id of the logical port into which the traceflow packet was delivered","title":"The id of the logical port into which the traceflow packet was delivered"}}}]},"IPv6Profiles":{"x-vmw-nsx-module":"LogicalRouter","type":"object","properties":{"dad_profile_id":{"type":"string","description":"Identifier of Duplicate Address Detection profile.\nDAD profile has various configurations related to duplicate\naddress detection. If no profile is associated manually to the router,\nthen the system defined default DAD profile will be automatically\napplied.\n","title":"DAD profile identifier"},"ndra_profile_id":{"type":"string","description":"Identifier of Neighbor Discovery Router Advertisement profile.\nNDRA profile has various configurations required for router\nadvertisement. If no profile is associated manually to the router,\nthen the system defined default NDRA profile will be automatically\napplied.\n","title":"NDRA profile identifier"}}},"MPResourceLinkedDetails":{"description":"Information about linked resource.\n","title":"Information about linked resource.\n","required":["key"],"x-vmw-nsx-module":"MPPolicyMigration","type":"object","properties":{"value":{"type":"string","description":"Resource id of the assocationed resource.","title":"Resource id of the assocationed resource."},"key":{"type":"string","description":"Associated resource type.","title":"Associated resource type."}}},"DnsForwarderStatus":{"x-vmw-nsx-module":"AggSvcDnsForwarder","type":"object","description":"The current runtime status of the DNS forwarder including the hosting\ntransport nodes and forwarder service status.\n","properties":{"status":{"readOnly":true,"enum":["UP","DOWN","ERROR","NO_BACKUP"],"type":"string","description":"UP means the DNS forwarder is working correctly on the active transport\nnode and the stand-by transport node (if present). Failover will occur\nif either node goes down.\nDOWN means the DNS forwarder is down on both active transport node and\nstandby node (if present). The DNS forwarder does not function in this\nsituation.\nError means there is some error on one or both transport node, or no\nstatus was reported from one or both transport nodes. The dns forwarder\nmay be working (or not working).\nNO_BACKUP means dns forwarder is working in only one transport node,\neither because it is down on the standby node, or no standby is configured.\nAn forwarder outage will occur if the active node goes down.\n"},"timestamp":{"description":"Time stamp of the current status, in ms","format":"int64","readOnly":true,"type":"integer"},"standby_node":{"readOnly":true,"type":"string","description":"Uuid of stand_by transport node. null if non-HA mode","title":"Uuid of stand_by transport node. null if non-HA mode"},"extra_message":{"readOnly":true,"type":"string","description":"Extra message, if available","title":"Extra message, if available"},"active_node":{"readOnly":true,"type":"string","description":"Uuid of active transport node","title":"Uuid of active transport node"}},"title":"The current runtime status of DNS forwarder"},"LogicalRouterLoopbackPort":{"x-vmw-nsx-module":"LogicalRouterPorts","allOf":[{"$ref":"#/definitions/LogicalRouterPort"},{"x-vmw-nsx-module":"LogicalRouterPorts","required":["subnets","edge_cluster_member_index"],"type":"object","properties":{"subnets":{"minItems":1,"items":{"$ref":"#/definitions/IPSubnet"},"type":"array","description":"Loopback port subnets","title":"Loopback port subnets"},"edge_cluster_member_index":{"items":{"type":"integer","format":"int64"},"type":"array","description":"Member index of the edge node on the cluster","title":"Member index of the edge node on the cluster"}}}]},"HealthCheckResultPerUplink":{"x-vmw-nsx-module":"HealthCheck","type":"object","description":"Health check result for specific uplink.\n","properties":{"uplink_name":{"readOnly":true,"type":"string","description":"Name of the uplink.","title":"Uplink Name"},"vlan_and_mtu_allowed":{"items":{"$ref":"#/definitions/HealthCheckVlanRange"},"readOnly":true,"type":"array","description":"List of VLAN ID ranges which are allowed by VLAN and MTU settings.\n","title":"VLAN and MTU Allowed"},"vlan_disallowed":{"items":{"$ref":"#/definitions/HealthCheckVlanRange"},"readOnly":true,"type":"array","description":"List of VLAN ID ranges which may be disallowed by VLAN settings.\n","title":"VLAN Disallowed"},"mtu_disallowed":{"items":{"$ref":"#/definitions/HealthCheckVlanRange"},"readOnly":true,"type":"array","description":"List of VLAN ID ranges which are allowed by VLAN settings but may be\ndisallowed by MTU settings.\n","title":"MTU Disallowed"}},"title":"Health Check Result Per Uplink"},"UplinkHostSwitchProfile":{"x-vmw-nsx-module":"UplinkHostSwitchProfile","allOf":[{"$ref":"#/definitions/BaseHostSwitchProfile"},{"required":["teaming"],"x-vmw-nsx-module":"UplinkHostSwitchProfile","type":"object","properties":{"lags":{"items":{"$ref":"#/definitions/Lag"},"type":"array","description":"list of LACP group","maxItems":64,"title":"list of LACP group"},"transport_vlan":{"description":"VLAN used for tagging Overlay traffic of associated HostSwitch","format":"int64","default":0,"type":"integer"},"teaming":{"$ref":"#/definitions/TeamingPolicy"},"overlay_encap":{"default":"GENEVE","enum":["VXLAN","GENEVE"],"type":"string","description":"The protocol used to encapsulate overlay traffic","title":"The protocol used to encapsulate overlay traffic"},"named_teamings":{"items":{"$ref":"#/definitions/NamedTeamingPolicy"},"type":"array","description":"List of named uplink teaming policies that can be used by logical switches","maxItems":32,"title":"List of named uplink teaming policies that can be used by logical switches"},"mtu":{"format":"int32","minimum":1280,"type":"integer","description":"Maximum Transmission Unit used for uplinks","title":"Maximum Transmission Unit used for uplinks"}}}],"description":"Profile for uplink policies","title":"Profile for uplink policies"},"NodeStatusProperties":{"x-vmw-nsx-module":"ApplianceStats","allOf":[{"$ref":"#/definitions/Resource"},{"x-vmw-nsx-module":"ApplianceStats","type":"object","properties":{"load_average":{"items":{"type":"number"},"readOnly":true,"type":"array","description":"One, five, and fifteen minute load averages for the system","title":"One, five, and fifteen minute load averages for the system"},"swap_used":{"readOnly":true,"format":"int64","type":"integer","description":"Amount of swap disk in use, in kilobytes","title":"Amount of swap disk in use, in kilobytes"},"cpu_usage":{"$ref":"#/definitions/CpuUsage"},"system_time":{"description":"Current time expressed in milliseconds since epoch","format":"int64","readOnly":true,"type":"integer"},"disk_space_total":{"readOnly":true,"format":"int64","type":"integer","description":"Amount of disk space available on the system, in kilobytes.","title":"Amount of disk space available on the system, in kilobytes"},"swap_total":{"readOnly":true,"format":"int64","type":"integer","description":"Amount of disk available for swap, in kilobytes","title":"Amount of disk available for swap, in kilobytes"},"non_dpdk_cpu_cores":{"readOnly":true,"format":"int64","type":"integer","description":"Number of non-DPDK cores on Edge Node.","title":"Number of non-DPDK CPU cores on the system"},"uptime":{"readOnly":true,"format":"int64","type":"integer","description":"Milliseconds since system start","title":"Milliseconds since system start"},"cpu_cores":{"readOnly":true,"format":"int64","type":"integer","description":"Number of CPU cores on the system","title":"Number of CPU cores on the system"},"dpdk_cpu_cores":{"readOnly":true,"format":"int64","type":"integer","description":"Number of DPDK cores on Edge Node which are used for packet IO processing.","title":"Number of DPDK CPU cores on the system"},"mem_used":{"readOnly":true,"format":"int64","type":"integer","description":"Amount of RAM in use on the system, in kilobytes","title":"Amount of RAM in use on the system, in kilobytes"},"mem_total":{"readOnly":true,"format":"int64","type":"integer","description":"Amount of RAM allocated to the system, in kilobytes","title":"Amount of RAM allocated to the system, in kilobytes"},"disk_space_used":{"readOnly":true,"format":"int64","type":"integer","description":"Amount of disk space in use on the system, in kilobytes","title":"Amount of disk space in use on the system, in kilobytes"},"mem_cache":{"readOnly":true,"format":"int64","type":"integer","description":"Amount of RAM on the system that can be flushed out to disk, in kilobytes","title":"Amount of RAM on the system that can be flushed out to disk, in kilobytes"},"hostname":{"readOnly":true,"type":"string","description":"Host name of the system","title":"Host name of the system"},"file_systems":{"items":{"$ref":"#/definitions/NodeFileSystemProperties"},"readOnly":true,"type":"array","description":"File systems configured on the system","title":"File systems configured on the system"},"source":{"description":"Source of status data.","enum":["realtime","cached"],"readOnly":true,"type":"string"},"edge_mem_usage":{"$ref":"#/definitions/EdgeTransportNodeMemoryUsage"}}}],"description":"Node status properties","title":"Node status properties"},"FirewallSectionState":{"x-vmw-nsx-module":"Firewall","allOf":[{"$ref":"#/definitions/DSSectionState"},{"x-vmw-nsx-module":"Firewall","required":["pending_change_list"],"type":"object","properties":{"pending_change_list":{"items":{"$ref":"#/definitions/PendingChange"},"type":"array","description":"Pending changes to be realized.","maxItems":100,"title":"List of pending changes"}}}]},"ClusterGroupMemberStatus":{"x-vmw-nsx-module":"Cluster","type":"object","description":"This type contains the attributes and status of a group member.","properties":{"member_ip":{"readOnly":true,"format":"ip","type":"string","description":"IP of the group member","title":"IP of the group member"},"member_fqdn":{"readOnly":true,"format":"hostname","type":"string","description":"FQDN of the group member","title":"FQDN of the group member"},"member_status":{"readOnly":true,"enum":["UP","DOWN","UNKNOWN"],"type":"string","description":"Status of the group member","title":"Status of the group member"},"member_uuid":{"readOnly":true,"type":"string","description":"UUID of the group member","title":"UUID of the group member"}},"title":"Status of a group member"},"DirectoryEventLogServerStatus":{"x-vmw-nsx-module":"DirectoryService","type":"object","description":"Event log server connection status","properties":{"status":{"readOnly":true,"enum":["OK","ERROR"],"type":"string","description":"Connection status:\n OK: All OK\n ERROR: Generic error\n","title":"Current connection status of event log server"},"error_message":{"readOnly":true,"type":"string","description":"Additional optional detail error message","title":"Additional optional detail error message"},"last_event_time_created":{"description":"Time of last successfully received and record event from event log server.","format":"int64","readOnly":true,"type":"integer"},"last_polling_time":{"description":"Last polling time","format":"int64","readOnly":true,"type":"integer"},"last_event_record_id":{"readOnly":true,"format":"int64","type":"integer","description":"Last event record ID is an opaque integer value that shows the last successfully received event from event log server.","title":"Last event record ID"}},"title":"Event log server connection status"},"PortConnectionContainersEntities":{"x-vmw-nsx-module":"PortConnection","type":"object","description":"Port Connection Containers Entities","properties":{"logical_ports":{"items":{"$ref":"#/definitions/LogicalPort"},"type":"array"}},"title":"Port Connection Containers Entities"},"DnsForwarderStatistics":{"x-vmw-nsx-module":"AggSvcDnsForwarder","type":"object","description":"The current statistics counters of the DNS forwarder including cache usages\nand query numbers per forwarders.\n","properties":{"queries_forwarded":{"readOnly":true,"format":"int64","type":"integer","description":"The total number of forwarded dns queries","title":"The total number of forwarded dns queries"},"conditional_forwarder_statistics":{"description":"The statistics of conditional forwarders","title":"The statistics of conditional forwarders","minItems":0,"items":{"$ref":"#/definitions/PerForwarderStatistics"},"readOnly":true,"maxItems":5,"type":"array"},"default_forwarder_statistics":{"$ref":"#/definitions/PerForwarderStatistics"},"queries_answered_locally":{"readOnly":true,"format":"int64","type":"integer","description":"The totocal number of queries answered from local cache","title":"The totocal number of queries answered from local cache"},"used_cache_statistics":{"description":"The statistics of used cache","title":"The statistics of used cache","minItems":0,"items":{"$ref":"#/definitions/PerNodeUsedCacheStatistics"},"readOnly":true,"maxItems":2,"type":"array"},"configured_cache_size":{"readOnly":true,"format":"int64","type":"integer","description":"The configured cache size, in kb","title":"The configured cache size, in kb"},"timestamp":{"description":"Time stamp of the current statistics, in ms","format":"int64","readOnly":true,"type":"integer"},"error_message":{"readOnly":true,"type":"string","description":"Error message, if available","title":"Error message, if available"},"total_queries":{"readOnly":true,"format":"int64","type":"integer","description":"The total number of received dns queries","title":"The total number of received dns queries"}},"title":"Statistics counters of the DNS forwarder"},"BaseServiceProfile":{"x-vmw-nsx-module":"ServiceInsertionCommonTypes","allOf":[{"$ref":"#/definitions/ManagedResource"},{"required":["resource_type"],"discriminator":"resource_type","x-vmw-nsx-module":"ServiceInsertionCommonTypes","type":"object","properties":{"resource_type":{"type":"string","description":"Service Profile type, for example 'GiServiceProfile', 'ServiceInsertionServiceProfile'","title":"Service Profile Resource type."}}}],"description":"Base Service Profile","title":"Base Service Profile"},"FirewallGlobalConfig":{"x-vmw-nsx-module":"GlobalConfigs","allOf":[{"$ref":"#/definitions/GlobalConfigs"},{"x-vmw-nsx-module":"GlobalConfigs","type":"object","properties":{"global_fastpath_mode_enabled":{"default":true,"type":"boolean","description":"This property is deprecated. The fast path mode is always enabled in Distributed Firewall.","x-deprecated":true,"title":"A flag to indicate if fast path searching is enabled in DFW"},"global_addrset_mode_enabled":{"default":true,"type":"boolean","description":"When this flag is set to true, global address set is enabled in Distributed Firewall.","title":"A flag to indicate if global address set is enabled in DFW"}}}],"description":"NSX global configs for Distributed Firewall","title":"NSX global configs for Distributed Firewall"},"BridgeHighAvailabilityClusterProfile":{"x-vmw-nsx-module":"BridgeHighAvailabilityClusterProfile","allOf":[{"$ref":"#/definitions/ClusterProfile"},{"x-vmw-nsx-module":"BridgeHighAvailabilityClusterProfile","type":"object","properties":{"enable":{"default":true,"type":"boolean","description":"whether the heartbeat is enabled","title":"whether the heartbeat is enabled"},"bfd_probe_interval":{"description":"the time interval (in millisec) between probe packets for heartbeat purpose","title":"the time interval (in millisec) between probe packets for heartbeat purpose","default":1000,"format":"int64","maximum":60000,"minimum":300,"type":"integer"}}}],"description":"Profile for BFD HA cluster setting","title":"Profile for BFD HA cluster setting"},"LbPoolStatisticsListResult":{"x-vmw-nsx-module":"AggSvcLb","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"AggSvcLb","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/LbPoolStatistics"},"type":"array","description":"paginated statistics list of pools","title":"paginated statistics list of pools"}}}]},"FeatureUsageListInCsvFormat":{"x-vmw-nsx-module":"License","allOf":[{"$ref":"#/definitions/CsvListResult"},{"x-vmw-nsx-module":"License","type":"object","properties":{"last_update_timestamp":{"description":"Timestamp when the data was last updated; unset if data source has\nnever updated the data.\n","format":"int64","readOnly":true,"type":"integer"},"results":{"items":{"$ref":"#/definitions/FeatureUsageCsvRecord"},"type":"array"}}}]},"IdfwEnabledComputeCollection":{"x-vmw-nsx-module":"IdentityFirewall","allOf":[{"$ref":"#/definitions/ManagedResource"},{"required":["compute_collection_id","enabled"],"x-vmw-nsx-module":"IdentityFirewall","type":"object","properties":{"compute_collection_name":{"type":"string","description":"Compute collection name.","title":"Compute collection name"},"enabled":{"type":"boolean","description":"Compute collection enabled status (true=Enabled / false=Disabled).","title":"Enabled/disabled"},"compute_collection_id":{"type":"string","description":"Compute collection ID.","title":"Compute collection ID"}}}],"description":"Compute collection enabled for Identity Firewall where login events will be\ncollected.\n","title":"Identity Firewall enabled compute collection"},"PortConnectionTunnel":{"description":"Tunnel information between two given transport nodes","title":"Tunnel information between two given transport nodes","required":["src_node_id","tunnel_properties"],"x-vmw-nsx-module":"PortConnection","type":"object","properties":{"src_node_id":{"type":"string","description":"Id of the source transport node","title":"Id of the source transport node"},"tunnel_properties":{"$ref":"#/definitions/TunnelProperties"}}},"LogicalSwitchMirrorSource":{"x-vmw-nsx-module":"PortMirroring","allOf":[{"$ref":"#/definitions/MirrorSource"},{"x-vmw-nsx-module":"PortMirroring","required":["switch_id"],"type":"object","properties":{"switch_id":{"type":"string","description":"Please note as logical port attached with vmk interface is unsupported\nas mirror source, traffic from those ports on source logical switch will\nnot be mirrored.\n","title":"Source logical switch identifier"}}}]},"CryptoAlgorithm":{"x-vmw-nsx-module":"CertificateManager","type":"object","properties":{"key_size":{"items":{"type":"integer","description":"Crypto key size","format":"int64"},"readOnly":true,"type":"array","description":"Supported key sizes for the algorithm."},"name":{"readOnly":true,"type":"string","description":"Crypto algorithm name."}}},"DiscoveredNode":{"x-vmw-nsx-module":"InventoryCmObj","allOf":[{"$ref":"#/definitions/DiscoveredResource"},{"x-vmw-nsx-module":"InventoryCmObj","type":"object","properties":{"stateless":{"readOnly":true,"type":"boolean","description":"The stateless property describes whether host persists its state across reboot or not. If state persists, value is set as false otherwise true.","title":"Specifies whether host is stateless"},"parent_compute_collection":{"readOnly":true,"type":"string","description":"External id of the compute collection to which this node belongs","title":"External id of the compute collection to which this node belongs"},"certificate":{"type":"string","description":"Certificate of the discovered node","title":"Certificate of the discovered node"},"origin_id":{"readOnly":true,"type":"string","description":"Id of the compute manager from where this node was discovered","title":"Id of the compute manager from where this node was discovered"},"ip_addresses":{"items":{"description":"IPv4 or IPv6 address","format":"ip","type":"string"},"readOnly":true,"type":"array","description":"IP Addresses of the the discovered node.","title":"IP Addresses of the the discovered node."},"hardware_id":{"readOnly":true,"type":"string","description":"Hardware Id is generated using system hardware info. It is used to retrieve fabric node of the esx.","title":"Hardware Id of the discovered node"},"os_version":{"readOnly":true,"type":"string","description":"OS version of the discovered node","title":"OS version of the discovered node"},"node_type":{"readOnly":true,"type":"string","description":"Discovered Node type like Host","title":"Discovered Node type like Host"},"os_type":{"readOnly":true,"type":"string","description":"OS type of the discovered node","title":"OS type of the discovered node"},"origin_properties":{"items":{"$ref":"#/definitions/KeyValuePair"},"readOnly":true,"type":"array","description":"Key-Value map of additional specific properties of discovered\nnode in the Compute Manager\n","title":"Key-Value map of additional specific properties of discovered\nnode in the Compute Manager\n"},"external_id":{"readOnly":true,"type":"string","description":"External id of the discovered node, ex. a mo-ref from VC","title":"External id of the discovered node, ex. a mo-ref from VC"},"cm_local_id":{"readOnly":true,"type":"string","description":"Local Id of the discovered node in the Compute Manager","title":"Local Id of the discovered node in the Compute Manager"}}}]},"SelectiveSyncSettings":{"x-vmw-nsx-module":"DirectoryService","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["enabled"],"x-vmw-nsx-module":"DirectoryService","type":"object","properties":{"enabled":{"type":"boolean","description":"Enable or disable SelectiveSync","title":"Enable or disable SelectiveSync"},"selected_org_units":{"items":{"type":"string"},"type":"array","description":"If SelectiveSync is enabled, this contains 1 or more\nOrgUnits, which NSX will synchronize with in LDAP server.\nThe full distiguished name (DN) should be used for OrgUnit.\nIf SelectiveSync is disabled, do not define this or specify an\nempty list.\n","title":"Selected OrgUnits for SelectiveSync"}}}],"description":"Directory domain selective sync settings","title":"Directory domain selective sync settings"},"MigrationStatsResult":{"x-vmw-nsx-module":"MPPolicyMigration","type":"object","properties":{"total_count":{"format":"int64","type":"integer","description":"Count of all objects being promoted. It is equal to sum of total_count for each\nresource type.\n","title":"Count of all objects being promoted."},"current_resource_type_in_promotion":{"type":"string","description":"This field used by UI which highlights the current resource type in promotion.\n","title":"Current Resource Type in Promotion"},"migration_stats":{"items":{"$ref":"#/definitions/MigrationStats"},"type":"array","description":"Promotion stats list results.\n","title":"Promotion stats list results."}}},"StandbyRelocationConfig":{"x-vmw-nsx-module":"EdgeHighAvailabilityProfile","type":"object","description":"Standby service contexts relocation setting","properties":{"standby_relocation_threshold":{"description":"The time interval (in minutes) to wait before starting the standby\nservice context relocation process. In some cases, the standby\nrelocation trigger may take more time than what is set in threshold\nbecause of multiple different reasons, as listed below\nA. Standby relocation process runs as a background task which poll edge\nclusters at pre-defined interval of 5 minutes, to check for standby relocation.\nIf during one cycle of standby relocation, an edge is found to be down, and the\ntime remaining to threshold expiry in less then 5 minutes (for example 2 minute),\nthan this relocation will be picked up in next cycle of standby relocation\nafter 5 minutes, and not after 2 minutes.\nB. If edge becomes down at X time, then edge might take few seconds or\nminutes for all services to completely go down and report that they are\ndown. So actual time when unified appliance knows edge is down may be X + delta.\nThis delta time adds to the actual standby relocation threshold expiry,\nand once the [standby relocation threshold time + delta time] is complete for an\nedge node, and the edge is still down, than the standby relocation task will be\nperformed for this edge node in the next cycle, that may be due to run anytime\nwithin next 5 minutes.\n","title":"Standby service context relocation wait time","default":30,"format":"int64","maximum":20000,"minimum":10,"type":"integer"}},"title":"Standby service contexts relocation setting"},"IpfixUpmProfile":{"x-vmw-nsx-module":"UpmIpfix","allOf":[{"$ref":"#/definitions/ManagedResource"},{"required":["resource_type"],"discriminator":"resource_type","x-vmw-nsx-module":"UpmIpfix","type":"object","properties":{"resource_type":{"description":"All IPFIX profile types.","enum":["IpfixSwitchUpmProfile"],"readOnly":false,"type":"string"}}}],"description":"Parent profile of all IPFIX profiles.","title":"Base IPFIX Profile"},"IdfwComputeCollectionCondition":{"description":"Status of the Identity Firewall enabled Compute collection.","title":"IDFW Compute collection status.","required":["status"],"x-vmw-nsx-module":"IdentityFirewall","type":"object","properties":{"status":{"enum":["UNKNOWN","UP","DOWN","DFW_DISABLED","IDFW_ENABLED","IDFW_DISABLED"],"type":"string","description":"IDFW enabled Compute collection status.","title":"IDFW enabled Compute collection status."},"status_detail":{"type":"string","description":"Status of the Compute collection.","title":"Compute collection status."}}},"OidcEndPointListResult":{"x-vmw-nsx-module":"CertificateManager","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"CertificateManager","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/OidcEndPoint"},"readOnly":true,"type":"array","description":"OidcEndPoint list."}}}],"description":"OidcEndPoint query result","title":"OidcEndPoint query result"},"L2VpnTunnelPeerCode":{"description":"L2Vpn tunnel peer code","title":"L2Vpn tunnel peer code","required":["transport_tunnel","peer_code"],"x-vmw-nsx-module":"L2VPN","type":"object","properties":{"transport_tunnel":{"$ref":"#/definitions/ResourceReference"},"peer_code":{"type":"string","description":"Copy this code to paste on the remote end of the tunnel. This is a base64 encoded string which has all the configuration for tunnel. E.g tap device local/peer ips and protocol, encryption algorithm, etc. The peer code also contains a pre-shared key; be careful when sharing or storing it.","title":"Peer code for the tunnel"}}},"TcpHeader":{"x-vmw-nsx-module":"Traceflow","type":"object","properties":{"tcp_flags":{"description":"TCP flags (9bits)","format":"int64","title":"TCP flags (9bits)","maximum":511,"minimum":0,"type":"integer"},"src_port":{"description":"Source port of tcp header","format":"int64","title":"Source port of tcp header","maximum":65535,"minimum":0,"type":"integer"},"dst_port":{"description":"Destination port of tcp header","format":"int64","title":"Destination port of tcp header","maximum":65535,"minimum":0,"type":"integer"}}},"LogicalDhcpServer":{"x-vmw-nsx-module":"Dhcp","allOf":[{"$ref":"#/definitions/ManagedResource"},{"required":["dhcp_profile_id"],"x-vmw-nsx-module":"Dhcp","type":"object","properties":{"attached_logical_port_id":{"readOnly":true,"type":"string","description":"The uuid of the attached logical port. Read only.","title":"Id of attached logical port"},"ipv6_dhcp_server":{"$ref":"#/definitions/IPv6DhcpServer"},"ipv4_dhcp_server":{"$ref":"#/definitions/IPv4DhcpServer"},"dhcp_profile_id":{"type":"string","description":"The DHCP profile uuid the logical DHCP server references.","title":"DHCP profile uuid"}}}],"description":"Definition of a logical DHCP server which can be attached a logical switch\nvia a logical port. Both ipv4_dhcp_server and ipv6_dhcp_server can be\nconfigured at the same time, or only configure either ipv4_dhcp_server or\nipv6_dhcp_server.\n","title":"Logical DHCP server"},"MigrationFeedbackCategory":{"x-vmw-nsx-module":"Migration","type":"object","description":"Categorization of feedback requests from the migration tool where user input is required.","properties":{"category":{"readOnly":true,"type":"string","description":"Functional area that this query falls into.","title":"Functional area for the feedback query"},"count":{"readOnly":true,"format":"int32","type":"integer","description":"Total number of feedback requests for this functional area.","title":"Total number of feedback requests for this functional area"},"resolved":{"readOnly":true,"format":"int32","type":"integer","description":"Total number of resolved feedback requests for this functional area.","title":"Count of resolved feedback requests for this functional area"},"accepted_values":{"items":{"type":"string"},"readOnly":true,"type":"array","description":"List of acceptable values for this feedback request.","title":"Acceptable values for this feedback request"}},"title":"Category of feedback for Migration"},"SolutionConfigListResult":{"x-vmw-nsx-module":"Nxgi","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"Nxgi","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/SolutionConfig"},"readOnly":true,"type":"array","description":"List of the Solution Config.","title":"Solution Config List"}}}],"description":"Solution Config List","title":"Solution Config List"},"BaseSwitchingProfile":{"x-vmw-nsx-module":"BaseSwitchingProfile","allOf":[{"$ref":"#/definitions/ManagedResource"},{"discriminator":"resource_type","x-vmw-nsx-module":"BaseSwitchingProfile","required":["resource_type"],"type":"object","properties":{"required_capabilities":{"items":{"type":"string"},"readOnly":true,"type":"array"},"resource_type":{"type":"string"}}}]},"ValidationError":{"x-vmw-nsx-module":"TransportNodeCollection","type":"object","description":"Error while applying transport node profile on discovered node","properties":{"discovered_node_id":{"readOnly":true,"type":"string","description":"Discovered Node Id","title":"Discovered Node Id"},"error_message":{"readOnly":true,"type":"string","description":"Validation error message","title":"Validation error message"}},"title":"Validation Error"},"PortConnectionEntities":{"description":"Port Connection Entities (to help draw a visual picture of entities between two ports)","title":"Port Connection Entities (to help draw a visual picture of entities between two ports)","required":["errors","logical_switches","hypervisors","tunnels","vms","containers"],"x-vmw-nsx-module":"PortConnection","type":"object","properties":{"containers":{"$ref":"#/definitions/PortConnectionContainersEntities"},"hypervisors":{"items":{"$ref":"#/definitions/PortConnectionHypervisor"},"type":"array"},"errors":{"items":{"$ref":"#/definitions/PortConnectionError"},"type":"array"},"logical_switches":{"items":{"$ref":"#/definitions/PortConnectionLogicalSwitch"},"type":"array"},"edge_node_groups":{"items":{"$ref":"#/definitions/PortConnectionEdgeNodeGroup"},"type":"array"},"routers":{"items":{"$ref":"#/definitions/PortConnectionRouter"},"type":"array"},"vms":{"items":{"$ref":"#/definitions/VirtualMachine"},"type":"array"},"tunnels":{"items":{"$ref":"#/definitions/PortConnectionTunnel"},"type":"array"},"physical_hosts":{"$ref":"#/definitions/PortConnectionBMEntities"}}},"SelectableResourceReference":{"x-vmw-nsx-module":"ClusterRestore","allOf":[{"$ref":"#/definitions/ResourceReference"},{"required":["selected"],"x-vmw-nsx-module":"ClusterRestore","type":"object","properties":{"selected":{"type":"boolean","description":"Set to true if this resource has been selected to be acted upon","title":"Set to true if this resource has been selected to be acted upon"}}}],"description":"Resources to take action on","title":"Resources to take action on"},"IpAllocationBase":{"x-vmw-nsx-module":"Dhcp","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"Dhcp","type":"object","properties":{"lease_time":{"description":"Lease time, in seconds, [60-(2^32-1)]. Default is 86400.","title":"Lease time","default":86400,"format":"int64","maximum":4294967295,"minimum":60,"type":"integer"},"gateway_ip":{"description":"Gateway ip address of the allocation.","format":"ip","type":"string"},"options":{"$ref":"#/definitions/DhcpOptions"}}}],"description":"Base type of ip-allocation extended by ip pool and static binding.\n","title":"Base type of ip-allocation"},"PerForwarderStatistics":{"x-vmw-nsx-module":"AggSvcDnsForwarder","type":"object","description":"Query statistics counters of a forwarder identified by domain names.\n","properties":{"upstream_statistics":{"description":"Statistics per upstream server.","title":"Statistics per upstream server.","minItems":0,"items":{"$ref":"#/definitions/PerUpstreamServerStatistics"},"readOnly":true,"maxItems":3,"type":"array"},"domain_names":{"description":"Domain names configured for the forwarder. Empty if this is the\ndefault forwarder.\n","title":"Domain names configured for the forwarder","minItems":0,"items":{"type":"string"},"readOnly":true,"maxItems":100,"type":"array"}},"title":"Per-forwarder query statistics counters"},"IpfixConfigListResult":{"x-vmw-nsx-module":"Ipfix","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"Ipfix","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/IpfixConfig"},"readOnly":true,"type":"array","description":"IPFIX Config","title":"IPFIX Config"}}}],"description":"List of IPFIX Config","title":"List of IPFIX Config"},"SetInterSiteAphCertificateRequest":{"x-vmw-nsx-module":"CertificateManager","type":"object","description":"Data for setting Appliance Proxy certificate for inter-site communication","properties":{"cert_id":{"readOnly":true,"type":"string","description":"ID of the certificate that is already imported.","title":"Certificate ID"},"used_by_id":{"readOnly":true,"type":"string","description":"ID of the node that this certificate is used on.","title":"Node ID"}},"title":"Data for setting Appliance Proxy certificate for inter-site communication"},"TransportNodeState":{"x-vmw-nsx-module":"TransportNode","allOf":[{"$ref":"#/definitions/ConfigurationState"},{"x-vmw-nsx-module":"TransportNode","type":"object","properties":{"deployment_progress_state":{"$ref":"#/definitions/TransportNodeDeploymentProgressState"},"transport_node_id":{"readOnly":true,"type":"string","description":"Unique Id of the TransportNode","title":"Unique Id of the TransportNode"},"remote_tunnel_endpoint_state":{"$ref":"#/definitions/RemoteTunnelEndpointConfigState"},"host_switch_states":{"items":{"$ref":"#/definitions/HostSwitchState"},"readOnly":true,"type":"array","description":"States of HostSwitches on the host","title":"States of HostSwitches on the host"},"maintenance_mode_state":{"description":"the present realized maintenance mode state","enum":["ENTERING","ENABLED","EXITING","DISABLED"],"readOnly":true,"type":"string"},"node_deployment_state":{"$ref":"#/definitions/ConfigurationState"}}}],"description":"Transport Node State","title":"Transport Node State"},"SoftwareModule":{"description":"Software module details","title":"Software module details","required":["module_name","module_version"],"x-vmw-nsx-module":"FabricNode","type":"object","properties":{"module_name":{"type":"string","description":"Name of the module in the node","title":"Name of the module in the node"},"module_version":{"type":"string","description":"Version of the module in the node","title":"Version of the module in the node"}}},"TraceActionConfig":{"x-vmw-nsx-module":"LiveTrace","type":"object","properties":{"sampling_argument":{"$ref":"#/definitions/SamplingArgument"},"action_argument":{"$ref":"#/definitions/TraceActionArgument"}}},"VdsUplink":{"description":"If Virtual Distributed Switch is used as a HostSwitch to configure TransportNode or TransportNodeProfie, this mapping should be specified. You can either use vds_uplink_name or vds_lag_name to associate with uplink_name from UplinkHostSwitch profile.","title":"VMware vSphere Distributed Switch (VDS) uplink/LAG mapping","required":["uplink_name"],"x-vmw-nsx-module":"TransportNode","type":"object","properties":{"vds_uplink_name":{"readOnly":false,"type":"string","description":"Uplink name of VDS that is connected to Physical NIC on a host from vSphere.","title":"Uplink name of VMware vSphere Distributed Switch (VDS)"},"uplink_name":{"readOnly":false,"type":"string","description":"This name is from UplinkHostSwitch profile that is associated with the HostSwitch specified in TransportNode or TransportNodeProfile configuration. This name will be used as an alias to either VDS uplink or lag in other configuration.","title":"Uplink name from UplinkHostSwitch profile"},"vds_lag_name":{"readOnly":false,"type":"string","description":"LAG name that is connected to Physical NIC on a host from vSphere.","title":"Link Aggregation Group (LAG) name of Virtual Distributed Switch"}}},"ClusteringInfo":{"x-vmw-nsx-module":"ClusterManagement","required":["join_to_existing_cluster"],"type":"object","description":"Clustering parameters for the controller cluster","properties":{"shared_secret":{"type":"string","description":"Shared secret of the cluster.","title":"Shared Secret of the cluster"},"join_to_existing_cluster":{"type":"boolean","description":"Property to indicate if the node must join an existing cluster.","title":"True If the controller node should join an existing cluster"}}},"BpduFilter":{"description":"BPDU filter configuration","title":"BPDU filter configuration","required":["enabled"],"x-vmw-nsx-module":"SwitchSecuritySwitchingProfile","type":"object","properties":{"white_list":{"description":"Pre-defined list of allowed MAC addresses to be excluded from BPDU filtering","title":"Pre-defined list of allowed MAC addresses to be excluded from BPDU filtering","minItems":0,"items":{"type":"string"},"readOnly":false,"maxItems":32,"type":"array"},"enabled":{"readOnly":false,"type":"boolean","description":"Indicates whether BPDU filter is enabled","title":"Indicates whether BPDU filter is enabled"}}},"DirectoryEventLogServer":{"x-vmw-nsx-module":"DirectoryService","allOf":[{"$ref":"#/definitions/ManagedResource"},{"required":["host"],"x-vmw-nsx-module":"DirectoryService","type":"object","properties":{"username":{"type":"string","description":"Directory event log server connection user name.","title":"Event log server username"},"status":{"$ref":"#/definitions/DirectoryEventLogServerStatus"},"host":{"format":"hostname-or-ip","type":"string","description":"Directory Event Log server DNS host name or ip address which is reachable by NSX manager to be connected and do event fetching.","title":"Event log server host name"},"password":{"type":"string","description":"Directory event log server connection password.","title":"Event log server password"},"domain_name":{"type":"string","description":"Directory domain name which best describes the domain. It could be unique fqdn name or it could also be descriptive. There is no unique contraint for domain name among different domains.","title":"Directory domain name"}}}],"description":"Event log server of directory domain","title":"Event log server of directory domain"},"UpgradeUnitTypeStats":{"x-vmw-nsx-module":"Upgrade","type":"object","properties":{"node_with_issues_count":{"readOnly":true,"format":"int32","type":"integer","description":"Number of nodes with issues that may cause upgrade failure","title":"Number of nodes with issues that may cause upgrade failure"},"node_count":{"readOnly":true,"format":"int32","type":"integer","description":"Number of nodes","title":"Number of nodes"},"version":{"readOnly":true,"type":"string","description":"Version of the upgrade unit","title":"Version of the upgrade unit"},"type":{"readOnly":true,"type":"string","description":"Type of upgrade unit","title":"Type of upgrade unit"},"upgrade_unit_subtype":{"readOnly":true,"enum":["RESOURCE","ACTION"],"type":"string","description":"UpgradeUnit sub type","title":"UpgradeUnit sub type"}}},"SVMDeploymentSpec":{"description":"Deployment Specs holds information required to deploy the Service-VMs.i.e. OVF url where the partner Service-VM OVF is hosted. The host type on which the OVF(Open Virtualization Format) can be deployed, Form factor to name a few.","title":"Service-VM Deployment Spec","required":["ovf_url","host_type"],"x-vmw-nsx-module":"ServiceInsertionCommonTypes","type":"object","properties":{"ovf_url":{"readOnly":false,"type":"string","description":"Location of the partner VM OVF to be deployed.","title":"OVF url"},"name":{"readOnly":false,"type":"string","description":"Deployment Spec name for ease of use, since multiple DeploymentSpec can be specified.","title":"name"},"min_host_version":{"default":"6.5","readOnly":false,"type":"string","description":"Minimum host version supported by this ovf. If a host in the deployment cluster is having version less than this, then service deployment will not happen on that host.","title":"Minimum Host Version"},"service_form_factor":{"description":"Supported ServiceInsertion Form Factor for the OVF deployment. The default FormFactor is Medium.","title":"Service Form Factor","default":"MEDIUM","enum":["SMALL","MEDIUM","LARGE"],"readOnly":false,"type":"string"},"host_type":{"readOnly":false,"enum":["ESXI","RHELKVM","UBUNTUKVM"],"type":"string","description":"Host Type on which the specified OVF can be deployed.","title":"HostType"},"svm_version":{"default":"1.0","type":"string","description":"Partner needs to specify the Service VM version which will get deployed.","title":"Partner Service-VM version."}}},"HostInfraTrafficType":{"x-vmw-nsx-module":"NiocProfile","type":"object","description":"The traffic_name specifies the infrastructure traffic type and it\nmust be one of the following system-defined types:\nFAULT_TOLERANCE is traffic for failover and recovery.\nHBR is traffic for Host based replication.\nISCSI is traffic for Internet Small Computer System Interface.\nMANAGEMENT is traffic for host management.\nNFS is traffic related to file transfer in network file system.\nVDP is traffic for vSphere data protection.\nVIRTUAL_MACHINE is traffic generated by virtual machines.\nVMOTION is traffic for computing resource migration.\nVSAN is traffic generated by virtual storage area network.\nThe dynamic_res_pool_name provides a name for the resource pool.\nIt can be any arbitrary string.\nEither traffic_name or dynamic_res_pool_name must be set.\nIf both are specified or omitted, an error will be returned.\n","properties":{"dynamic_res_pool_name":{"type":"string","description":"Dynamic resource pool traffic name","title":"Dynamic resource pool traffic name"},"traffic_name":{"enum":["FAULT_TOLERANCE","HBR","ISCSI","MANAGEMENT","NFS","VDP","VIRTUAL_MACHINE","VMOTION","VSAN"],"type":"string","description":"Traffic types","title":"Traffic types"}},"title":"Enumerate all types of traffic"},"VerifiableAsymmetricLoginCredential":{"x-vmw-nsx-module":"Types","allOf":[{"$ref":"#/definitions/LoginCredential"},{"x-vmw-nsx-module":"Types","type":"object","properties":{"asymmetric_credential":{"type":"string","description":"Asymmetric login credential","title":"Asymmetric login credential"},"credential_verifier":{"type":"string","description":"Credential verifier","title":"Credential verifier"},"credential_key":{"type":"string","description":"Credential key","title":"Credential key"}}}]},"IPSecVPNDPDProfileListResult":{"x-vmw-nsx-module":"IPSecVPN","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"IPSecVPN","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/IPSecVPNDPDProfile"},"type":"array","description":"IPSec DPD Profile list results","title":"IPSec DPD Profile list results"}}}],"description":"List all the dead peer detection (DPD) profiles.","title":"List dead peer detection (DPD) profiles"},"IpPoolSubnet":{"x-vmw-nsx-module":"Ipam","description":"A set of IPv4 or IPv6 addresses defined by a network CIDR.","allOf":[{"$ref":"#/definitions/Resource"},{"x-vmw-nsx-module":"Ipam","required":["cidr","allocation_ranges"],"type":"object","properties":{"dns_nameservers":{"description":"The collection of upto 3 DNS servers for the subnet.","title":"The collection of upto 3 DNS servers for the subnet.","items":{"description":"IPv4 or IPv6 address","format":"ip","type":"string"},"maxItems":3,"uniqueItems":true,"type":"array"},"cidr":{"type":"string","description":"Represents network address and the prefix length which will be associated with a layer-2 broadcast domain","title":"Represents network address and the prefix length which will be associated with a layer-2 broadcast domain"},"gateway_ip":{"description":"The default gateway address on a layer-3 router.","format":"ip","type":"string"},"allocation_ranges":{"items":{"$ref":"#/definitions/IpPoolRange"},"type":"array","description":"A collection of IPv4 or IPv6 IP Pool Ranges.","title":"A collection of IPv4 or IPv6 IP Pool Ranges."},"dns_suffix":{"format":"hostname","type":"string","description":"The DNS suffix for the DNS server.","title":"The DNS suffix for the DNS server."}}}]},"NodeInterfaceStatisticsProperties":{"x-vmw-nsx-module":"ApplianceStats","allOf":[{"$ref":"#/definitions/Resource"},{"x-vmw-nsx-module":"ApplianceStats","type":"object","properties":{"tx_dropped":{"format":"int64","type":"integer","description":"Number of packets dropped","title":"Number of packets dropped"},"rx_packets":{"format":"int64","type":"integer","description":"Number of packets received","title":"Number of packets received"},"tx_carrier":{"format":"int64","type":"integer","description":"Number of carrier losses detected","title":"Number of carrier losses detected"},"rx_bytes":{"format":"int64","type":"integer","description":"Number of bytes received","title":"Number of bytes received"},"tx_errors":{"format":"int64","type":"integer","description":"Number of transmit errors","title":"Number of transmit errors"},"interface_id":{"type":"string","description":"Interface ID","title":"Interface ID"},"tx_colls":{"format":"int64","type":"integer","description":"Number of collisions detected","title":"Number of collisions detected"},"rx_frame":{"format":"int64","type":"integer","description":"Number of framing errors","title":"Number of framing errors"},"rx_errors":{"format":"int64","type":"integer","description":"Number of receive errors","title":"Number of receive errors"},"tx_bytes":{"format":"int64","type":"integer","description":"Number of bytes transmitted","title":"Number of bytes transmitted"},"rx_dropped":{"format":"int64","type":"integer","description":"Number of packets dropped","title":"Number of packets dropped"},"tx_packets":{"format":"int64","type":"integer","description":"Number of packets transmitted","title":"Number of packets transmitted"},"source":{"description":"Source of status data.","enum":["realtime","cached"],"type":"string"}}}],"description":"Node network interface statistic properties","title":"Node network interface statistic properties"},"ReservationInfo":{"x-vmw-nsx-module":"FabricNode","type":"object","description":"CPU and Memory resource configuration is defined per Edge VM\nform factor.\nThese resources are reserved 100 percent by default with Normal VM\nimportance. Resource reservation tuning provides a means to optimize\nresource utilization and workaround hard resource limits.\nThis solution should be used as a temporary workaround. It is recommended\nto add more resources to the compute cluster and change the reservation\nback to 100 percent for optimal performance.\n","properties":{"cpu_reservation":{"$ref":"#/definitions/CPUReservation"},"memory_reservation":{"$ref":"#/definitions/MemoryReservation"}}},"InstallUpgradeServiceProperties":{"description":"install-upgrade service properties","title":"install-upgrade service properties","required":["enabled"],"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"enabled_on":{"readOnly":true,"type":"string","description":"IP of manager on which install-upgrade is enabled","title":"IP of manager on which install-upgrade is enabled"},"enabled":{"type":"boolean","description":"True if service enabled; otherwise, false","title":"True if service enabled; otherwise, false"}}},"MigrationSwitchInfo":{"x-vmw-nsx-module":"Migration","type":"object","description":"Details about switch to be migrated","properties":{"kind":{"description":"Kind of switch, can be DVS, VSS.","title":"Kind of switch","default":"DVS","enum":["DVS","VSS"],"readOnly":false,"type":"string"},"version":{"readOnly":true,"type":"string","description":"Version of the switch to be migrated.","title":"Switch version"},"pnic_count":{"readOnly":true,"format":"int32","type":"integer","description":"Number of PNICs associated with this switch.","title":"PNIC count"},"id":{"readOnly":true,"type":"string","description":"Switch Identifier.","title":"Switch id"},"name":{"readOnly":false,"type":"string","description":"Name of the switch.","title":"Switch name"}},"title":"Details about switch to be migrated"},"DonutConfiguration":{"x-vmw-nsx-module":"NsxDashboard","allOf":[{"$ref":"#/definitions/WidgetConfiguration"},{"required":["sections"],"x-vmw-nsx-module":"NsxDashboard","type":"object","properties":{"count":{"type":"string","description":"Expression to retrieve count to be shown on Donut.","title":"Expression to retrieve count to be shown on Donut"},"navigation":{"maxLength":1024,"type":"string","description":"Hyperlink of the specified UI page that provides details.","title":"Navigation to a specified UI page"},"display_count":{"default":true,"type":"boolean","description":"If true, displays the count of entities in the donut","title":"Show or hide the count of entities"},"sections":{"minItems":1,"items":{"$ref":"#/definitions/DonutSection"},"type":"array","description":"Sections","title":"Sections"},"label":{"$ref":"#/definitions/Label"}}}],"description":"Represents configuration of a Donut","title":"Donut Configuration"},"PerNodeDnsFailedQueries":{"x-vmw-nsx-module":"DnsForwarder","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"DnsForwarder","type":"object","properties":{"timestamp":{"readOnly":true,"type":"string","description":"Timestamp of the request, in YYYY-MM-DD HH:MM:SS.zzz format.","title":"Timestamp of the request"},"node_id":{"readOnly":true,"type":"string","description":"The Uuid of active/standby transport node.","title":"Uuid of active/standby transport node"},"results":{"items":{"$ref":"#/definitions/DnsFailedQuery"},"readOnly":true,"type":"array","description":"The list of failed DNS queries.","title":"List of failed DNS queries"}}}],"description":"The list of the failed DNS queries with entry count and timestamp.\nThe entry count is for per active/standby transport node.\n","title":"The list of failed DNS queries per transport node"},"SupportBundleResult":{"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"request_properties":{"$ref":"#/definitions/SupportBundleRequest"},"failed_nodes":{"items":{"$ref":"#/definitions/FailedNodeSupportBundleResult"},"readOnly":true,"type":"array","description":"Nodes where bundles were not generated or not copied to remote server","title":"Nodes where bundles were not generated or not copied to remote server"},"success_nodes":{"items":{"$ref":"#/definitions/SuccessNodeSupportBundleResult"},"readOnly":true,"type":"array","description":"Nodes whose bundles were successfully copied to remote file server","title":"Nodes whose bundles were successfully copied to remote file server"},"remaining_nodes":{"items":{"$ref":"#/definitions/RemainingSupportBundleNode"},"type":"array","description":"Nodes where bundle generation is pending or in progress","title":"Nodes where bundle generation is pending or in progress"}}},"ClusterConfiguration":{"x-vmw-nsx-module":"Cluster","type":"object","description":"The configuration of the NSX cluster. The cluster configuration consists of a list of cluster node attributes.","properties":{"config_version":{"readOnly":true,"format":"int64","type":"integer","description":"Cluster configuration version","title":"Cluster configuration version"},"nodes":{"items":{"$ref":"#/definitions/ClusterNode"},"readOnly":true,"type":"array","description":"Nodes in the cluster configuration","title":"Nodes in the cluster configuration"},"cluster_id":{"readOnly":true,"type":"string","description":"UUID of the cluster","title":"UUID of the cluster"}},"title":"Cluster configuration"},"CapacityThreshold":{"x-vmw-nsx-module":"CapacityDashboard","required":["max_threshold_percentage","threshold_type","min_threshold_percentage"],"type":"object","properties":{"max_threshold_percentage":{"minimum":0,"type":"number","description":"Set the maximum threshold percentage. Specify a value between 0 and\n100. Usage percentage above this value is tagged as critical.\n","maximum":100,"title":"Maximum threshold percentage"},"threshold_type":{"type":"string","description":"Indicate the object type for which threshold is to be set.\n","title":"Object type for which threshold is to be set"},"min_threshold_percentage":{"minimum":0,"type":"number","description":"Set the minimum threshold percentage. Specify a value between 0 and\n100. Usage percentage above this value is tagged as warning.\n","maximum":100,"title":"Minimum threshold percentage"}}},"FeatureUsage":{"x-vmw-nsx-module":"License","description":"feature usage result item","allOf":[{"$ref":"#/definitions/Resource"},{"x-vmw-nsx-module":"License","type":"object","properties":{"capacity_usage":{"items":{"$ref":"#/definitions/CapacityUsage"},"readOnly":true,"type":"array","description":"Capacity Usage List","title":"Capacity Usage List"},"feature":{"readOnly":true,"type":"string","description":"name of the feature","title":"name of the feature"}}}]},"RoleBinding":{"x-vmw-nsx-module":"AAA","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"AAA","type":"object","properties":{"identity_source_type":{"default":"VIDM","enum":["VIDM","LDAP","OIDC"],"type":"string","description":"Identity source type","title":"Identity source type"},"user_id":{"readOnly":true,"type":"string","description":"Local user's numeric id on the system.","title":"Local user's numeric id"},"name":{"readOnly":true,"type":"string","description":"User/Group's name","title":"User/Group's name"},"roles":{"items":{"$ref":"#/definitions/Role"},"readOnly":true,"type":"array","description":"The roles of the user.","title":"Roles"},"type":{"readOnly":true,"enum":["remote_user","remote_group","local_user","principal_identity"],"type":"string","description":"Type","title":"Type"},"stale":{"readOnly":true,"enum":["TRUE","FALSE","UNKNOWN"],"type":"string","description":"Property 'stale' can be considered to have these values - absent - This type of rolebinding does not support stale property TRUE - Rolebinding is stale in vIDM meaning the user is no longer present in vIDM FALSE - Rolebinding is available in vIDM UNKNOWN - Rolebinding's state of staleness in unknown Once rolebindings become stale, they can be deleted using the API POST /aaa/role-bindings?action=delete_stale_bindings","title":"Stale in vIDM"},"identity_source_id":{"type":"string","description":"The ID of the external identity source that holds the referenced external entity. Currently, only external LDAP and OIDC servers are allowed.","title":"ID of the external identity source"}}}],"description":"User/Group's role binding","title":"User/Group's role binding"},"ApplianceProcessData":{"x-vmw-nsx-module":"ShaApplianceMonitor","allOf":[{"$ref":"#/definitions/Resource"},{"x-vmw-nsx-module":"ShaApplianceMonitor","type":"object","properties":{"top_process_by_cpu_count":{"format":"int64","type":"integer","description":"Display the total count of process.","title":"Process count"},"name":{"type":"string","description":"Display the appliance name.","title":"Appliance name"},"top_process_by_mem_list":{"items":{"$ref":"#/definitions/ProcessInformation"},"type":"array","description":"Display the top process list by memory.","title":"Top process list by memory"},"timestamp":{"type":"integer","description":"Timestamp of last modification.","format":"int64"},"top_process_by_mem_count":{"format":"int64","type":"integer","description":"Display the total count of process.","title":"Process count"},"id":{"type":"string","description":"Display the Appliance id.","title":"Appliance id"},"top_process_by_cpu_list":{"items":{"$ref":"#/definitions/ProcessInformation"},"type":"array","description":"Display the top process list by CPU.","title":"Top process list by CPU"}}}],"description":"List of process data in given appliance node","title":"List of process data in given appliance node"},"RegistrationToken":{"description":"Appliance registration access token","title":"Appliance registration access token","required":["roles"],"x-vmw-nsx-module":"RegistrationTokenEndPoint","type":"object","properties":{"token":{"type":"string","description":"Access token","title":"Access token"},"user":{"type":"string","description":"User delegated by token","title":"User delegated by token"},"roles":{"items":{"type":"string"},"type":"array","description":"List results","title":"List results"}}},"VniRange":{"x-vmw-nsx-module":"Vnim","description":"A range of virtual network identifiers (VNIs)","allOf":[{"$ref":"#/definitions/Resource"},{"x-vmw-nsx-module":"Vnim","required":["start","end"],"type":"object","properties":{"start":{"description":"Start value for vni range to be used for virtual networks","title":"Start value of vni range","format":"int64","maximum":16777215,"readOnly":false,"minimum":5000,"type":"integer"},"end":{"description":"End value for vni range to be used for virtual networks","title":"End value of vni range","format":"int64","maximum":16777215,"readOnly":false,"minimum":5000,"type":"integer"}}}]},"RoutingConfig":{"x-vmw-nsx-module":"Routing","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"Routing","type":"object","properties":{"forwarding_up_timer":{"format":"int64","type":"integer","description":"Defines the extra time the router must wait before sending the UP notification\nafter the first BGP session is established. Default means forward immediately.\nFor TIER0/TIER1 logical router, default is 0. VRF logical router will set it same as\nparent logical router.\n","title":"Forwarding up timer"},"logical_router_id":{"readOnly":true,"type":"string","description":"Logical router id","title":"Logical router id"}}}]},"TransportProtocolHeader":{"x-vmw-nsx-module":"Traceflow","type":"object","properties":{"udp_header":{"$ref":"#/definitions/UdpHeader"},"dhcp_header":{"$ref":"#/definitions/DhcpHeader"},"tcp_header":{"$ref":"#/definitions/TcpHeader"},"icmp_echo_request_header":{"$ref":"#/definitions/IcmpEchoRequestHeader"},"dhcpv6_header":{"$ref":"#/definitions/Dhcpv6Header"},"ndp_header":{"$ref":"#/definitions/NdpHeader"},"dns_header":{"$ref":"#/definitions/DnsHeader"}}},"LatencyStatProfile":{"x-vmw-nsx-module":"Latency","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"Latency","type":"object","properties":{"sampling_interval":{"description":"Event nth milliseconds packet is sampled. When a value less than\n1000 is given, the realized sampling interval will be 1000 milliseconds.\n","format":"int64","title":"Latency sampling interval","maximum":1000000,"minimum":1,"type":"integer"},"sampling_rate":{"description":"Event nth packet is sampled.\n","format":"int64","title":"Latency sampling rate","maximum":1000000,"minimum":100,"type":"integer"},"pnic_latency_enabled":{"default":false,"readOnly":false,"type":"boolean","description":"Enable or Disable pnic latency.\n"}}}],"description":"Latency stat service profile\n","title":"Latency Stat Profile"},"PlainFilterData":{"x-vmw-nsx-module":"LiveTrace","allOf":[{"$ref":"#/definitions/LiveTraceFilterData"},{"x-vmw-nsx-module":"LiveTrace","type":"object","properties":{"extend_filter":{"type":"string","description":"Extended RCF rule for packet filter","title":"Extended RCF rule for packet filter"},"basic_filter":{"type":"string","description":"Basic RCF rule for packet filter","title":"Basic RCF rule for packet filter"}}}]},"MigrationUnitListResult":{"x-vmw-nsx-module":"Migration","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"Migration","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/MigrationUnit"},"type":"array","description":"Paged Collection of Migration units","title":"Paged Collection of Migration units"}}}]},"LbVirtualServerStatistics":{"x-vmw-nsx-module":"AggSvcLb","required":["statistics","virtual_server_id"],"type":"object","properties":{"last_update_timestamp":{"type":"integer","description":"Timestamp when the data was last updated","format":"int64"},"statistics":{"$ref":"#/definitions/LbStatisticsCounter"},"virtual_server_id":{"type":"string","description":"load balancer virtual server identifier","title":"load balancer virtual server identifier"}}},"UpgradeUnitAggregateInfoListResult":{"x-vmw-nsx-module":"Upgrade","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"Upgrade","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/UpgradeUnitAggregateInfo"},"readOnly":true,"type":"array","description":"Paged collection of UpgradeUnit AggregateInfo","title":"Paged collection of UpgradeUnit AggregateInfo"}}}]},"IdfwTransportNodeStatusListResult":{"x-vmw-nsx-module":"IdentityFirewall","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"IdentityFirewall","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/IdfwTransportNodeStatus"},"type":"array","description":"List of transport node ids and status for idfw enabled\nCompute collection.\n","title":"IDFW enabled Compute collection transport node list."}}}],"description":"Status of the Identity Firewall enabled Compute collection\ntransport nodes.\n","title":"IDFW enabled Compute collection transport node and status list."},"UpgradeCheckCsvRecord":{"x-vmw-nsx-module":"Upgrade","allOf":[{"$ref":"#/definitions/CsvRecord"},{"required":["check_name","upgrade_unit_type"],"x-vmw-nsx-module":"Upgrade","type":"object","properties":{"status":{"readOnly":true,"enum":["SUCCESS","FAILURE","WARNING"],"type":"string","description":"Status of the pre/post-upgrade check","title":"Status of the upgrade check"},"check_description":{"readOnly":false,"type":"string","description":"Description of the pre/post-upgrade check","title":"Description of the upgrade check"},"failure_messages":{"readOnly":true,"type":"string","description":"Space-separated list of failure messages","title":"Failure messages"},"check_name":{"readOnly":false,"type":"string","description":"Display name of the pre/post-upgrade check","title":"Name of the upgrade check"},"upgrade_unit_id":{"readOnly":true,"type":"string","description":"Identifier of the upgrade unit","title":"UUID of the upgrade unit"},"upgrade_unit_metadata":{"readOnly":true,"type":"string","description":"Meta-data of the upgrade-unit","title":"Meta-data of the upgrade-unit"},"upgrade_unit_type":{"readOnly":false,"type":"string","description":"Component type of the upgrade unit","title":"Component type"}}}],"description":"CSV record for a pre/post-upgrade check","title":"CSV record for an upgrade-check"},"IdfwUserStats":{"description":"Identity Firewall user login/session data for a single user.","title":"Identity Firewall user login/session data for a single user","required":["active_sessions"],"x-vmw-nsx-module":"IdentityFirewall","type":"object","properties":{"user_id":{"readOnly":true,"type":"string","description":"AD user Identifier (String ID)","title":"AD user Identifier (String ID)"},"active_sessions":{"items":{"$ref":"#/definitions/IdfwUserSessionData"},"type":"array","description":"List of active (still logged in) user login/sessions data (no limit)","title":"List of active (still logged in) user login/sessions data (no limit)"},"archived_sessions":{"items":{"$ref":"#/definitions/IdfwUserSessionData"},"type":"array","description":"Optional list of up to 5 most recent archived (previously logged in) user\nlogin/session data.\n","title":"List of archived (previously logged in) user login/session data"}}},"MigrationStats":{"x-vmw-nsx-module":"MPPolicyMigration","type":"object","description":"Provide stats about ongoing MP2Policy promotion.\n","properties":{"total_count":{"type":"string","description":"Total mp resource count","title":"Total mp resource count"},"promotion_status":{"enum":["NOT_STARTED","IN_PROGRESS","PROCESSING","DONE"],"type":"string","description":"Promotion status","title":"Promotion status"},"failed_objects_count":{"type":"string","description":"failed mp resource count","title":"failed mp resource count"},"resource_type":{"type":"string","description":"Resource type","title":"Resource type"},"promoted_objects_count":{"type":"string","description":"promoted mp resource count","title":"promoted mp resource count"}},"title":"Provide stats about ongoing MP2Policy promotion\n"},"IdfwSystemStats":{"description":"Identity Firewall statistics data.","title":"Identity Firewall statistics data","required":["num_concurrent_users","num_user_sessions"],"x-vmw-nsx-module":"IdentityFirewall","type":"object","properties":{"num_concurrent_users":{"format":"int32","type":"integer","description":"Number of concurrent logged on users (across VDI & RDSH). Multiple\nlogins by the same user is counted as 1.\n","title":"Number of concurrent logged on users (across VDI & RDSH)"},"num_user_sessions":{"format":"int32","type":"integer","description":"Number of active user sessions/logins in IDFW enabled compute collections\n(including both UP and DOWN hosts). N sessions/logins by the same user\nis counted as n.\n","title":"Number of active user sessions/logins"}}},"LogicalRouterPortArpTable":{"x-vmw-nsx-module":"AggSvcLogicalRouterPort","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"AggSvcLogicalRouterPort","required":["logical_router_port_id"],"type":"object","properties":{"last_update_timestamp":{"description":"Timestamp when the data was last updated; unset if data source has never updated the data.","format":"int64","readOnly":true,"type":"integer"},"results":{"items":{"$ref":"#/definitions/LogicalRouterPortArpEntry"},"type":"array"},"logical_router_port_id":{"type":"string","description":"The ID of the logical router port","title":"The ID of the logical router port"}}}]},"ScpProtocol":{"x-vmw-nsx-module":"MISSING_MODULE","allOf":[{"$ref":"#/definitions/Protocol"},{"x-vmw-nsx-module":"MISSING_MODULE","required":["ssh_fingerprint","authentication_scheme"],"type":"object","properties":{"ssh_fingerprint":{"type":"string","description":"SSH fingerprint of server","title":"SSH fingerprint of server"},"authentication_scheme":{"$ref":"#/definitions/PasswordAuthenticationScheme"}}}]},"DSInsertParameters":{"x-vmw-nsx-module":"DistributedServices","type":"object","description":"Parameters to tell where rule/section need to be added. All the params take rule/section Id.","properties":{"operation":{"default":"insert_top","enum":["insert_top","insert_bottom","insert_after","insert_before"],"type":"string","description":"Operation","title":"Operation"},"id":{"maxLength":64,"type":"string","description":"Identifier of the anchor rule or section. This is a required field in case operation like 'insert_before' and 'insert_after'.","title":"Identifier of the anchor rule or section. This is a required field in case operation like 'insert_before' and 'insert_after'."}},"title":"Parameters to tell where rule/section need to be added. All the params take rule/section Id."},"LogicalRouterRouteTable":{"x-vmw-nsx-module":"AggSvcLogicalRouter","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"AggSvcLogicalRouter","required":["logical_router_id"],"type":"object","properties":{"logical_router_name":{"readOnly":true,"type":"string","description":"Name of the logical router","title":"Name of the logical router"},"last_update_timestamp":{"description":"Timestamp when the data was last updated; unset if data source has never updated the data.","format":"int64","readOnly":true,"type":"integer"},"logical_router_id":{"type":"string","description":"The id of the logical router","title":"The id of the logical router"},"results":{"items":{"$ref":"#/definitions/LogicalRouterRouteEntry"},"type":"array"}}}]},"DhcpV6StaticBinding":{"x-vmw-nsx-module":"Dhcp","allOf":[{"$ref":"#/definitions/DhcpV6InfoBase"},{"x-vmw-nsx-module":"Dhcp","type":"object","properties":{"ip_addresses":{"description":"When not specified, no ip address will be assigned to client host.","title":"Ip address list","minItems":0,"items":{"description":"IPv6 address","format":"ipv6","type":"string"},"maxItems":1,"type":"array"},"mac_address":{"description":"The MAC address of the host. Either client-duid or mac-address,\nbut not both.\n","format":"mac-address","type":"string"}}}],"description":"DHCP IPv6 static binding to define a static ip allocation.","title":"DHCP IPv6 static binding"},"LocalSiteConfiguration":{"description":"Local site with federation id and epoch.","title":"Local site information","required":["epoch","id","site"],"x-vmw-nsx-module":"SiteManagerModule","type":"object","properties":{"epoch":{"format":"int64","type":"integer","description":"Epoch","title":"Epoch"},"id":{"type":"string","description":"Federation id","title":"Federation id"},"site":{"$ref":"#/definitions/FederationSite"}}},"UpgradeBundleInfo":{"x-vmw-nsx-module":"Upgrade","type":"object","description":"Information about the upgrade bundle","properties":{"url":{"readOnly":true,"type":"string","description":"URL for uploading upgrade bundle","title":"URL of the upgrade bundle"},"bundle_size":{"readOnly":true,"type":"string","description":"size of upgrade bundle","title":"size of upgrade bundle"}},"title":"Information about upgrade bundle"},"RoutingGlobalConfig":{"x-vmw-nsx-module":"GlobalConfigs","allOf":[{"$ref":"#/definitions/GlobalConfigs"},{"required":["l3_forwarding_mode"],"x-vmw-nsx-module":"GlobalConfigs","type":"object","properties":{"logical_uplink_mtu":{"description":"This is the global default MTU for all the logical uplinks in a NSX domain. Currently logical uplink MTU can only be set globally and applies to the entire NSX domain. There is no option to override this value at transport zone level or transport node level. If this value is not set, the default value of 1500 will be used.","format":"int32","default":1500,"title":"MTU for the logical uplinks","readOnly":false,"type":"integer"},"vdr_mac_nested":{"description":"This is the global default MAC address for all VDRs in all transport nodes in a NSX system nested in another NSX system. All transport zones in such a nested NSX system will have the \"nested_nsx\" property being true so that all transport nodes will use this MAC for the VDR ports to avoid conflict with the VDR MAC in the outer NSX system. When the property \"allow_changing_vdr_mac_in_use\" is false, it can not be changed if the current VDR MAC is being used by any transport node in a nested NSX environment. A transport node uses this VDR MAC if any host switch in the node is in an OVERLAY transport zone whose \"nested_nsx\" property is true.","default":"02:50:56:56:44:53","format":"mac-address","type":"string"},"allow_changing_vdr_mac_in_use":{"default":false,"type":"boolean","description":"When this flag is set to true, it is allowed to change the VDR MAC being used by existing transport nodes in a NSX system. The VDR MAC used by a host switch in a transport node is decided by the OVERLAY transport zone(s) which the host switch joins. If any of the OVERLAY transport zone(s) has \"nested_nsx\" property being true, the MAC in \"vdr_mac_nested\" is used; otherwise the MAC in \"vdr_mac\" is used. Thus the VDR MAC being used by a host switch in a transport node can be changed in below ways. If the host switch is not in any OVERLAY transport zone whose \"nested_nsx\" property is true but is in an OVERLAY transport zone, the first way is updating the \"vdr_mac\" property. The 2nd way is updating one of the OVERLAY tranport zones joined by the host switch to set \"nested_nsx\" property true which will make the host switch use the VDR MAC in \"vdr_mac_nested\". The third way is directly updating the transport node to add an OVERLAY transport zone whose \"nested_nsx\" property is true into the host switch which will also make the host switch use the VDR MAC in \"vdr_mac_nested\". If the host switch is in some OVERLAY transport zone(s) whose \"nested_nsx\" property is true, the first way is updating the \"vdr_mac_nested\" property. The 2nd way is updating all those OVERLAY tranport zones to set \"nested_nsx\" property false which will make the host switch use the VDR MAC in \"vdr_mac\". The third way is directly updating the transport node to remove all those OVERLAY transport zones from the host switch which will also make the host switch use the VDR MAC in \"vdr_mac\". Please note that changing the VDR MAC being used by existing transport nodes will most likely cause traffic disruption and network outage!","title":"A flag to indicate if changing the VDR MAC being used is allowed"},"l3_forwarding_mode":{"default":"IPV4_ONLY","enum":["IPV4_ONLY","IPV4_AND_IPV6"],"type":"string","description":"This setting does not restrict configuration as per other modes. But the forwarding will only work as per the mode set here.","title":"L3 forwarding mode"},"vdr_mac":{"description":"This is the global default MAC address for all VDRs in all transport nodes in a NSX system. When the property \"allow_changing_vdr_mac_in_use\" is false, it can not be changed if the current VDR MAC is being used by any transport node. A transport node uses this VDR MAC if any host switch in the node is in OVERLAY transport zone(s) but none of the transport zone(s) has \"nested_nsx\" property being true.","default":"02:50:56:56:44:52","format":"mac-address","type":"string"}}}],"description":"NSX global configs for Routing","title":"NSX global configs for Routing"},"LbClientSslProfileListResult":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"LoadBalancer","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/LbClientSslProfile"},"type":"array","description":"paginated list of load balancer client SSL profiles","title":"paginated list of load balancer client SSL profiles"}}}]},"LbVariablePersistenceOnAction":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/LbRuleAction"},{"required":["variable_name"],"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"variable_hash_enabled":{"default":false,"type":"boolean","description":"The property is used to enable a hash operation for variable value\nwhen composing the persistence key.\n","title":"Whether to enable a hash operation for variable value"},"variable_name":{"type":"string","description":"The property is the name of variable to be used. It specifies which\nvariable's value of a HTTP Request will be used in the key of\npersistence entry. The variable can be a system embedded variable such\nas \"_cookie_JSESSIONID\", a customized variable defined in\nLbVariableAssignmentAction or a captured variable in regular expression\nsuch as \"article\".\n","title":"Variable name"},"persistence_profile_id":{"type":"string","description":"If the persistence profile UUID is not specified, a default\npersistence table is created per virtual server. Currently, only\nLbGenericPersistenceProfile is supported.\n","title":"UUID of LbPersistenceProfile"}}}],"description":"This action is performed in HTTP forwarding phase. It is used to inspect\nthe variable of HTTP request, and look up the persistence entry with its\nvalue and pool uuid as key.\nIf the persistence entry is found, the HTTP request is forwarded to the\nrecorded backend server according to the persistence entry.\nIf the persistence entry is not found, a new entry is created in the\ntable after backend server is selected.\n","title":"Action to persist the variable value"},"IPSecVPNPolicyTrafficStatistics":{"x-vmw-nsx-module":"VPNStatistics","type":"object","description":"IPSec VPN policy traffic statistics","properties":{"aggregate_traffic_counters":{"$ref":"#/definitions/IPSecVPNTrafficCounters"},"tunnel_statistics":{"items":{"$ref":"#/definitions/IPSecVPNTunnelTrafficStatistics"},"readOnly":true,"type":"array","description":"Tunnel statistics.","title":"Tunnel statistics"},"tunnel_port_id":{"readOnly":true,"type":"string","description":"Tunnel port identifier.","title":"Tunnel port identifier"},"policy_id":{"readOnly":true,"type":"string","description":"Policy Identifier.","title":"Policy Identifier"}},"title":"IPSec VPN policy traffic statistics"},"NodeCapability":{"x-vmw-nsx-module":"FabricNode","type":"object","description":"Capability of a fabric node","properties":{"value":{"readOnly":true,"type":"string","description":"Value of this capability","title":"Value of this capability"},"version":{"readOnly":true,"format":"int32","type":"integer","description":"Version of the capability","title":"Version of the capability"},"description":{"readOnly":true,"type":"string","description":"Description of this capability that can be displayed in UI","title":"Description of this capability that can be displayed in UI"},"key":{"readOnly":true,"type":"string","description":"String that identifies the base capability for all nodes","title":"String that identifies the base capability for all nodes"},"provider":{"readOnly":true,"type":"string","description":"Provider of this capability for the node","title":"Provider of this capability for the node"}},"title":"Capability of a fabric node"},"MACAddressElement":{"x-vmw-nsx-module":"MACSet","allOf":[{"$ref":"#/definitions/RevisionedResource"},{"required":["mac_address"],"x-vmw-nsx-module":"MACSet","type":"object","properties":{"mac_address":{"description":"A MAC address. Must be 6 pairs of hexadecimal digits, upper or lower case,\nseparated by colons or dashes. Examples: 01:23:45:67:89:ab, 01-23-45-67-89-AB.\n","format":"mac-address","type":"string"}}}],"description":"MAC Address","title":"MAC Address"},"DeploymentSpecName":{"x-vmw-nsx-module":"ServiceInsertionCommonTypes","type":"object","description":"Used to provide the deployment spec for Upgrade.","properties":{"deployment_spec_name":{"readOnly":true,"type":"string","description":"This indicates the deployment spec.","title":"Deployment Spec Name"}},"title":"Deployment spec to be used in upgrade"},"MigrationSummary":{"x-vmw-nsx-module":"Migration","type":"object","properties":{"target_version":{"readOnly":true,"type":"string","description":"Target system version","title":"Target system version"},"migration_status":{"readOnly":true,"enum":["SUCCESS","FAILED","IN_PROGRESS","NOT_STARTED","PAUSING","PAUSED"],"type":"string","description":"Status of migration","title":"Status of migration"},"migration_coordinator_version":{"readOnly":true,"type":"string","description":"Current version of migration coordinator","title":"Current version of migration coordinator"},"system_version":{"readOnly":true,"type":"string","description":"Current system version","title":"Current system version"},"component_target_versions":{"items":{"$ref":"#/definitions/ComponentTargetVersion"},"readOnly":true,"type":"array"}}},"TraceflowRequest":{"x-vmw-nsx-module":"Traceflow","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"Traceflow","required":["packet","lport_id"],"type":"object","properties":{"packet":{"$ref":"#/definitions/PacketData"},"timeout":{"description":"Maximum time (in ms) the management plane will wait for observation result list to be sent by controller plane. Upper limit for federation case is 90000, for non-federation case is 15000, the maximum is set to 90000 as the higher of the two cases.","title":"Timeout (in ms) for traceflow observations result list","default":10000,"format":"int64","maximum":90000,"minimum":5000,"type":"integer"},"lport_id":{"type":"string","description":"id of the source logical port to inject the traceflow packet into","title":"id of the source logical port to inject the traceflow packet into"}}}]},"ExtraConfig":{"description":"Extra config is intended for supporting vendor specific configuration on the\ndata path, it can be set as key value string pairs on either logical switch\nor logical port.\nIf it was set on logical switch, it will be inherited automatically by logical\nports in it. Also logical port setting will override logical switch setting\nif specific key was dual set on both logical switch and logical port.\n","title":"Vendor specific configuration on logical switch or logical port","required":["config_pair"],"x-vmw-nsx-module":"Switching","type":"object","properties":{"config_pair":{"$ref":"#/definitions/UnboundedKeyValuePair"}}},"UpgradePlanSettings":{"x-vmw-nsx-module":"Upgrade","type":"object","properties":{"pause_after_each_group":{"default":false,"readOnly":false,"type":"boolean","description":"Flag to indicate whether to pause the upgrade after upgrade of each group is completed","title":"Flag to indicate whether to pause the upgrade after upgrade of each group is completed"},"pause_on_error":{"default":false,"readOnly":false,"type":"boolean","description":"Flag to indicate whether to pause the upgrade plan execution when an error occurs","title":"Flag to indicate whether to pause the upgrade plan execution when an error occurs"},"parallel":{"default":true,"readOnly":false,"type":"boolean","description":"Upgrade Method to specify whether the upgrade is to be performed serially or in parallel","title":"Upgrade Method to specify whether the upgrade is to be performed serially or in parallel"}}},"UcFunctionalState":{"x-vmw-nsx-module":"Upgrade","type":"object","description":"Upgrade coordinator Uc functional State.","properties":{"state":{"readOnly":true,"enum":["RUNNING","STANDBY"],"type":"string","description":"function state of the upgrade coordinator","title":"State of UC UI"},"error_message":{"readOnly":true,"type":"string","description":"error message that explains why UC is on standby mode.","title":"error message"}},"title":"Uc Functional State"},"VmToolsInfo":{"x-vmw-nsx-module":"VmToolsInfo","allOf":[{"$ref":"#/definitions/DiscoveredResource"},{"x-vmw-nsx-module":"VmToolsInfo","type":"object","properties":{"source":{"$ref":"#/definitions/ResourceReference"},"vm_type":{"readOnly":true,"enum":["EDGE","SERVICE","REGULAR"],"type":"string","description":"Type of VM - Edge, Service or other.","title":"Virtual Machine type"},"host_local_id":{"readOnly":true,"type":"string","description":"Id of the VM which is assigned locally by the host. It is the VM-moref on ESXi hosts, in other environments it is VM UUID.","title":"VM ID given by the host"},"network_agent_version":{"readOnly":true,"type":"string","description":"Version of network agent on the VM of a third party partner solution.","title":"Network agent version on the VM"},"file_agent_version":{"readOnly":true,"type":"string","description":"Version of file agent on the VM of a third party partner solution.","title":"File agent version on the VM"},"external_id":{"readOnly":true,"type":"string","description":"Current external id of this virtual machine in the system.","title":"VM external ID"},"tools_version":{"readOnly":true,"type":"string","description":"Version of VMTools installed on the VM.","title":"VM tools version on the VM"},"svm_connectivity":{"readOnly":true,"type":"boolean","description":"Endpoint Protection (Third party AV partner using NXGI) status on the VM. TRUE - VM is configured and protected by EPP Service VM. FALSE - VM is either not configured for protection or VM is disconnected from EPP Service VM.","title":"Endpoint Protection status on the VM"},"svmStatus":{"items":{"$ref":"#/definitions/SvmConnectivityStatus"},"type":"array","description":"Connectivity Status between each Guest Introspection Solution deployed in the data center with the guest VM.","title":"SvmConnectivityStatus list."}}}]},"ManualHealthCheck":{"x-vmw-nsx-module":"HealthCheck","allOf":[{"$ref":"#/definitions/ManagedResource"},{"required":["transport_zone_id","vlans"],"x-vmw-nsx-module":"HealthCheck","type":"object","properties":{"transport_zone_id":{"type":"string","description":"The entity ID works as a filter param. Entity ID and entity type should\n be both provided or not at a query.\n","title":"Transport Zone ID"},"vlans":{"$ref":"#/definitions/HealthCheckSpecVlans"},"operation_status":{"readOnly":true,"enum":["IN_PROGRESS","FINISHED"],"type":"string","description":"The operation status for health check\n","title":"Operation Status"},"result":{"$ref":"#/definitions/HealthCheckResult"}}}],"description":"Describes a manual check to evaluate the status of a transport zone.\n","title":"Manual Health Check"},"PoolMember":{"x-vmw-nsx-module":"LoadBalancer","required":["ip_address"],"type":"object","properties":{"max_concurrent_connections":{"description":"To ensure members are not overloaded, connections to a member can be\ncapped by the load balancer. When a member reaches this limit, it is\nskipped during server selection.\nIf it is not specified, it means that connections are unlimited.\n","format":"int64","title":"maximum concurrent connection number","maximum":2147483647,"minimum":1,"type":"integer"},"admin_state":{"description":"member admin state","default":"ENABLED","enum":["ENABLED","DISABLED","GRACEFUL_DISABLED"],"type":"string"},"backup_member":{"default":false,"type":"boolean","description":"Backup servers are typically configured with a sorry page indicating to\nthe user that the application is currently unavailable. While the pool\nis active (a specified minimum number of pool members are active)\nBACKUP members are skipped during server selection. When the pool is\ninactive, incoming connections are sent to only the BACKUP member(s).\n","title":"determine whether the pool member is for backup usage"},"weight":{"description":"Pool member weight is used for WEIGHTED_ROUND_ROBIN balancing\nalgorithm. The weight value would be ignored in other algorithms.\n","title":"pool member weight","default":1,"format":"int64","maximum":256,"minimum":1,"type":"integer"},"display_name":{"type":"string","description":"pool member name","title":"pool member name"},"ip_address":{"description":"pool member IP address","format":"ip","type":"string"},"port":{"description":"If port is specified, all connections will be sent to this port. Only\nsingle port is supported.\nIf unset, the same port the client connected to will be used, it could\nbe overrode by default_pool_member_port setting in virtual server.\nThe port should not specified for port range case.\n","format":"port-or-range","type":"string"}}},"DnsFailedQuery":{"description":"The summary of the failed DNS query. The query result represents a full\nquery chain from client VM to dns forwarder, and upstream server if no\nforwarder cache was hit.\n","title":"The failed DNS query","required":["timestamp"],"x-vmw-nsx-module":"DnsForwarder","type":"object","properties":{"time_spent":{"format":"int64","type":"integer","description":"The time the query took before it got a failed answer, in ms.","title":"Time spent in the query, if applicable"},"record_type":{"type":"string","description":"The record type be queried, e.g. A, CNAME, SOA, etc.","title":"The record type be queried"},"client_ip":{"type":"string","description":"The client host ip address from which the query was issued.\n","title":"The client host ip address from which the query was issued"},"upstream_server_ip":{"type":"string","description":"The upstream server ip address to which the query was forwarded. If the\nquery could not be serviced from the DNS forwarder cache, this property\nwill contain the IP address of the DNS server that serviced the request.\nIf the request was serviced from the cache, this property will be absent.\n","title":"The ip address to which the query was forwarded"},"error_message":{"type":"string","description":"The detailed error message of the failed query, if any.","title":"The error message of the failed query"},"address":{"type":"string","description":"The address be queried, can be a FQDN or an ip address.","title":"The adddress be queried"},"timestamp":{"type":"string","description":"Timestamp of the request, in YYYY-MM-DD HH:MM:SS.zzz format.","title":"Timestamp of the request"},"error_type":{"type":"string","description":"The type of the query failure, e.g. NXDOMAIN, etc.","title":"The type of the failure"},"source_ip":{"type":"string","description":"The source ip address that is used to forward a query to an upstream\nserver.\n","title":"The source ip address for forwarding query"},"forwarder_ip":{"type":"string","description":"The DNS forwarder ip address to which the query was first received.\n","title":"The DNS forwarder ip address to which the query was first received"}}},"TaskListResult":{"x-vmw-nsx-module":"Tasks","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"Tasks","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/TaskProperties"},"type":"array","description":"Task property results","title":"Task property results"}}}],"description":"Task query results","title":"Task query results"},"ServiceRouterAllocationConfig":{"x-vmw-nsx-module":"LogicalRouter","required":["edge_cluster_id"],"type":"object","properties":{"edge_cluster_member_indices":{"items":{"type":"integer","format":"int64"},"type":"array","description":"For TIER 1 logical router, for manual placement of service router\nwithin the cluster, edge cluster member indices needs to be provided\nelse same will be auto-allocated. You can provide maximum two indices\nfor HA ACTIVE_STANDBY.\n","title":"Member indices of the edge node on the cluster"},"allocation_pool":{"$ref":"#/definitions/EdgeClusterMemberAllocationPool"},"edge_cluster_id":{"type":"string","description":"To reallocate TIER1 logical router on new or existing edge cluster\n","title":"Edge cluster id to re allocate members"}}},"DhcpIpPool":{"x-vmw-nsx-module":"Dhcp","allOf":[{"$ref":"#/definitions/IpAllocationBase"},{"required":["allocation_ranges"],"x-vmw-nsx-module":"Dhcp","type":"object","properties":{"allocation_ranges":{"items":{"$ref":"#/definitions/IpPoolRange"},"type":"array","description":"Ip-ranges to define dynamic ip allocation ranges.","title":"Ip-ranges"},"warning_threshold":{"description":"Warning threshold. Alert will be raised if the pool usage reaches the\ngiven threshold.\n","title":"Warning threshold, valid [50-80], default 80","default":80,"format":"int64","maximum":80,"minimum":50,"type":"integer"},"error_threshold":{"description":"Error threshold. Alert will be raised if the pool usage reaches the\ngiven threshold.\n","title":"Error threshold, valid [80-100], default 100","default":100,"format":"int64","maximum":100,"minimum":80,"type":"integer"}}}],"description":"DHCP ip-pool to define dynamic ip allocation ranges.","title":"DHCP ip-pool"},"LogicalRouterStatusPerNode":{"x-vmw-nsx-module":"AggSvcLogicalRouter","required":["high_availability_status","transport_node_id"],"type":"object","properties":{"sub_cluster_id":{"type":"string","description":"This field is populated for sateful active-active mode.\nRuntime state is only synced among nodes in the same sub cluster.\n","title":"Sub cluster id for the node."},"high_availability_status":{"enum":["ACTIVE","STANDBY","DOWN","SYNC","UNKNOWN","ADMIN_DOWN"],"type":"string","description":"A service router's HA status on an edge node","title":"A service router's HA status on an edge node"},"service_router_id":{"type":"string","description":"id of the service router where the router status is retrieved.","title":"id of the service router where the router status is retrieved."},"edge_path":{"type":"string","description":"Only populated by Policy APIs","title":"edge transport node path."},"transport_node_id":{"type":"string","description":"id of the transport node where the router status is retrieved.","title":"id of the transport node where the router status is retrieved."}}},"LogicalRouterPortState":{"x-vmw-nsx-module":"LogicalRouterPorts","allOf":[{"$ref":"#/definitions/EdgeConfigurationState"},{"x-vmw-nsx-module":"LogicalRouterPorts","type":"object","properties":{"ipv6_dad_statuses":{"items":{"$ref":"#/definitions/IPv6DADStatus"},"readOnly":true,"type":"array","description":"Array of DAD status which contains DAD information for IP addresses\non the port.\n","title":"DAD Status"}}}],"description":"This holds the state of Logical Router Port. If there are errors\nin realizing LRP outside of MP, it gives details of the components and\nspecific errors.\n","title":"Realization State of Logical Router Port."},"ServiceInsertionStatusListResult":{"x-vmw-nsx-module":"ServiceInsertionStatus","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"ServiceInsertionStatus","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/ServiceInsertionStatus"},"readOnly":true,"type":"array"}}}],"description":"List of service insertion statuses for a context or all context","title":"Service Insertion Statuses"},"AuditLogRequest":{"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"log_filter":{"type":"string","description":"Audit logs should meet the filter condition","title":"Audit logs should meet the filter condition"},"log_age_limit":{"format":"int64","minimum":0,"type":"integer","description":"Include logs with timstamps not past the age limit in days","title":"Include logs with timstamps not past the age limit in days"},"log_filter_type":{"default":"TEXT","enum":["TEXT","REGEX"],"type":"string","description":"Type of log filter","title":"Type of log filter"}}},"LoggingServiceProperties":{"description":"Service properties","title":"Service properties","required":["logging_level"],"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"package_logging_level":{"items":{"$ref":"#/definitions/PackageLoggingLevels"},"type":"array","description":"Package logging levels","title":"Package logging levels"},"logging_level":{"enum":["OFF","FATAL","ERROR","WARN","INFO","DEBUG","TRACE"],"type":"string","description":"Service logging level","title":"Service logging level"},"modified_package_logging_levels":{"type":"string","description":"Modified package logging levels","title":"Modified package logging levels"}}},"GroupedMigrationFeedbackRequestListResult":{"x-vmw-nsx-module":"Migration","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"Migration","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/GroupedMigrationFeedbackRequest"},"readOnly":false,"type":"array","description":"Paged Collection of groups of feedback requests","title":"Paged Collection of groups of feedback requests"}}}],"description":"Groups of detailed feedback requests from the migration tool where user input is required.","title":"groups of feedback required for Migration"},"LogicalRouterPortStatistics":{"x-vmw-nsx-module":"AggSvcLogicalRouterPort","required":["logical_router_port_id"],"type":"object","properties":{"per_node_statistics":{"description":"Per Node Statistics","title":"Per Node Statistics","items":{"$ref":"#/definitions/LogicalRouterPortStatisticsPerNode"},"readOnly":true,"additionalProperties":false,"type":"array"},"logical_router_port_id":{"type":"string","description":"The ID of the logical router port","title":"The ID of the logical router port"}}},"SnmpV3User":{"description":"SNMP v3 user properties","title":"SNMP v3 user","required":["user_id"],"x-vmw-nsx-module":"CentralNodeConfig","type":"object","properties":{"priv_password":{"type":"string","description":"SNMP v3 user private password","title":"Private password"},"auth_password":{"type":"string","description":"SNMP v3 user auth password","title":"Auth password"},"user_id":{"type":"string","description":"SNMP v3 user ID","title":"User ID"}}},"IPSecVPNPolicyRule":{"x-vmw-nsx-module":"IPSecVPN","allOf":[{"$ref":"#/definitions/EmbeddedResource"},{"x-vmw-nsx-module":"IPSecVPN","type":"object","properties":{"sources":{"items":{"$ref":"#/definitions/IPSecVPNPolicySubnet"},"type":"array","description":"List of local subnets.","maxItems":128,"title":"Source list"},"action":{"description":"PROTECT - Protect rules are defined per policy based\nIPSec VPN session.\nBYPASS - Bypass rules are defined per IPSec VPN\nservice and affects all policy based IPSec VPN sessions.\nBypass rules are prioritized over protect rules.\n","title":"Action to be applied","default":"PROTECT","enum":["PROTECT","BYPASS"],"readOnly":true,"type":"string"},"enabled":{"default":true,"type":"boolean","description":"A flag to enable/disable the policy rule.","title":"Enabled flag"},"logged":{"default":false,"type":"boolean","description":"A flag to enable/disable the logging for the policy rule.","title":"Logging flag"},"id":{"type":"string","description":"Unique policy id.","title":"Unique policy id"},"destinations":{"items":{"$ref":"#/definitions/IPSecVPNPolicySubnet"},"type":"array","description":"List of peer subnets.","maxItems":128,"title":"Destination list"}}}],"description":"For policy-based IPsec VPNs, a security policy specifies as its action the VPN tunnel to be used for transit traffic that meets the policy's match criteria.","title":"IPSec VPN policy rules"},"DSSectionState":{"x-vmw-nsx-module":"DistributedServices","allOf":[{"$ref":"#/definitions/ConfigurationState"},{"x-vmw-nsx-module":"DistributedServices","type":"object","properties":{"revision_desired":{"readOnly":true,"format":"int64","type":"integer","description":"This attribute represents revision number of section's desired state.","title":"Section's desired state revision number"}}}],"description":"Section Realization Status","title":"Section Realization State"},"SpoofGuardSwitchingProfile":{"x-vmw-nsx-module":"SpoofGuardSwitchingProfile","allOf":[{"$ref":"#/definitions/BaseSwitchingProfile"},{"required":["white_list_providers"],"x-vmw-nsx-module":"SpoofGuardSwitchingProfile","type":"object","properties":{"white_list_providers":{"items":{"description":"Ways to provide white listed addresses for SpoofGuard","enum":["LPORT_BINDINGS","LSWITCH_BINDINGS"],"type":"string"},"readOnly":false,"type":"array","description":"List of providers for white listed address bindings.","title":"List of providers for white listed address bindings."}}}],"description":"SpoofGuard configuration","title":"SpoofGuard configuration"},"ServiceManagerListResult":{"x-vmw-nsx-module":"ServiceInsertion","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"ServiceInsertion","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/ServiceManager"},"readOnly":true,"type":"array","description":"List of the Service-managers.","title":"Service manager list"}}}],"description":"Service Manager List Result","title":"Service Manager List Result"},"LogicalRouterUpLinkPort":{"x-vmw-nsx-module":"LogicalRouterPorts","allOf":[{"$ref":"#/definitions/LogicalRouterPort"},{"x-vmw-nsx-module":"LogicalRouterPorts","required":["subnets","edge_cluster_member_index"],"type":"object","properties":{"subnets":{"minItems":1,"items":{"$ref":"#/definitions/IPSubnet"},"type":"array","description":"Logical router port subnets","title":"Logical router port subnets"},"linked_logical_switch_port_id":{"$ref":"#/definitions/ResourceReference"},"ndra_prefix_config":{"items":{"$ref":"#/definitions/NDRAPrefixConfig"},"type":"array","description":"Configuration to override the neighbor discovery router advertisement\nprefix time parameters at the subnet level. Note that users are allowed\nto override the prefix time only for IPv6 subnets which are configured\non the port.\n"},"igmp_config":{"$ref":"#/definitions/InterfaceIgmpLocalGroupConfig"},"edge_cluster_member_index":{"items":{"type":"integer","format":"int64"},"type":"array","description":"Member index of the edge node on the cluster","title":"Member index of the edge node on the cluster"},"urpf_mode":{"description":"Unicast Reverse Path Forwarding mode","default":"STRICT","enum":["NONE","STRICT"],"type":"string"},"mac_address":{"readOnly":true,"type":"string","description":"MAC address","title":"MAC address"},"pim_config":{"$ref":"#/definitions/InterfacePimConfig"},"ndra_profile_id":{"type":"string","description":"Identifier of Neighbor Discovery Router Advertisement profile\nassociated with port. When NDRA profile id is associated at\nboth the port level and logical router level, the profile id\nspecified at port level takes the precedence.\n","title":"Identifier for NDRA profile on the port"},"mtu":{"format":"int64","minimum":64,"type":"integer","description":"Maximum transmission unit specifies the size of the largest packet that\na network protocol can transmit. If not specified, the global logical\nMTU set in the /api/v1/global-configs/RoutingGlobalConfig API will be\nused.\n","title":"Maximum transmission unit (MTU)"}}}]},"ClusterStatus":{"x-vmw-nsx-module":"ClusterManagement","type":"object","properties":{"mgmt_cluster_status":{"$ref":"#/definitions/ManagementClusterStatus"},"control_cluster_status":{"$ref":"#/definitions/ControllerClusterStatus"},"cluster_id":{"readOnly":true,"type":"string","description":"Unique identifier of this cluster","title":"Unique identifier of this cluster"},"detailed_cluster_status":{"$ref":"#/definitions/AllClusterGroupStatus"}}},"ErrorResolverInfo":{"x-vmw-nsx-module":"ErrorResolver","required":["error_id","resolver_present"],"type":"object","description":"Metadata related to a given error_id","properties":{"error_id":{"format":"int64","type":"integer","description":"The error id for which metadata information is needed","title":"The error id for which metadata information is needed"},"resolver_present":{"type":"boolean","description":"Indicates whether there is a resolver associated with the error or not","title":"Indicates whether there is a resolver associated with the error or not"},"user_metadata":{"$ref":"#/definitions/ErrorResolverUserMetadata"}}},"Layout":{"x-vmw-nsx-module":"NsxDashboard","type":"object","description":"Represents layout of a container or widget","properties":{"type":{"default":"HORIZONTAL","enum":["HORIZONTAL","VERTICAL","GRID","AUTO"],"type":"string","description":"Describes layout of a container or widget. Layout describes how individual widgets are placed inside the container. For example, if HORIZONTAL is chosen widgets are placed side by side inside the container. If VERTICAL is chosen then widgets are placed one below the other. If GRID is chosen then the container or widget display area is divided into a grid of m rows and n columns, as specified in the properties, and the widgets are placed inside the grid. If AUTO is chosen then container or widgets display area will be automatically calculated depending upon the required width.","title":"Type of layout of a container or widget"},"properties":{"$ref":"#/definitions/LayoutProperties"}},"title":"Layout of a container or widget"},"DhcpOptions":{"x-vmw-nsx-module":"Dhcp","type":"object","description":"Define DHCP options of the DHCP service.","properties":{"option121":{"$ref":"#/definitions/DhcpOption121"},"others":{"description":"To define DHCP options other than option 121 in generic format.\nPlease note, only the following options can be defined in generic\nformat. Those other options will be accepted without validation\nbut will not take effect.\n--------------------------\n Code Name\n--------------------------\n 2 Time Offset\n 6 Domain Name Server\n 13 Boot File Size\n 19 Forward On/Off\n 26 MTU Interface\n 28 Broadcast Address\n 35 ARP Timeout\n 40 NIS Domain\n 41 NIS Servers\n 42 NTP Servers\n 44 NETBIOS Name Srv\n 45 NETBIOS Dist Srv\n 46 NETBIOS Node Type\n 47 NETBIOS Scope\n 58 Renewal Time\n 59 Rebinding Time\n 64 NIS+-Domain-Name\n 65 NIS+-Server-Addr\n 66 TFTP Server-Name (used by PXE)\n 67 Bootfile-Name (used by PXE)\n 93 PXE: Client system architecture\n 94 PXE: Client NDI\n 97 PXE: UUID/UNDI\n 117 Name Service Search\n 119 Domain Search\n 150 TFTP server address (used by PXE)\n 175 Etherboot\n 209 PXE Configuration File\n 210 PXE Path Prefix\n 211 PXE Reboot Time\n","title":"Generic DHCP options other than option 121","minItems":0,"items":{"$ref":"#/definitions/GenericDhcpOption"},"maxItems":255,"type":"array"}},"title":"DHCP options"},"IPSecVPNPeerEndpointListResult":{"x-vmw-nsx-module":"IPSecVPN","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"IPSecVPN","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/IPSecVPNPeerEndpoint"},"type":"array","description":"IPSec Peer endpoint list results","title":"IPSec Peer endpoint list results"}}}],"description":"List all the peer endpoints.","title":"List peer endpoints"},"NodeNetworkInterfaceProperties":{"x-vmw-nsx-module":"MISSING_MODULE","allOf":[{"$ref":"#/definitions/Resource"},{"required":["ip_configuration"],"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"physical_address":{"readOnly":true,"type":"string","description":"Interface MAC address","title":"Interface MAC address"},"broadcast_address":{"type":"string","description":"Interface broadcast address","title":"Interface broadcast address"},"link_status":{"readOnly":true,"enum":["up","down"],"type":"string","description":"Interface administration status","title":"Interface administration status"},"default_gateway":{"type":"string","description":"Interface's default gateway","title":"Interface's default gateway"},"bond_primary":{"type":"string","description":"Bond's primary device name in active-backup bond mode","title":"Bond's primary device name in active-backup bond mode"},"bond_slaves":{"items":{"type":"string"},"type":"array","description":"Bond's slave devices","title":"Bond's slave devices"},"ip_addresses":{"items":{"$ref":"#/definitions/IPv4AddressProperties"},"type":"array","description":"Interface IP addresses","maxItems":1,"title":"Interface IP addresses"},"vlan":{"description":"VLAN Id","title":"VLAN Id","format":"int64","maximum":4094,"readOnly":true,"minimum":1,"type":"integer"},"admin_status":{"readOnly":true,"enum":["up","down"],"type":"string","description":"Interface administration status","title":"Interface administration status"},"bond_primary_slave":{"readOnly":true,"type":"string","description":"Bond's primary device name in active-backup bond mode","title":"Bond's primary device name in active-backup bond mode"},"mtu":{"format":"int64","type":"integer","description":"Interface MTU","title":"Interface MTU"},"bond_mode":{"enum":["ACTIVE_BACKUP","802_3AD","ROUND_ROBIN","BROADCAST","XOR","TLB","ALB"],"type":"string","description":"Bond mode","title":"Bond mode"},"plane":{"enum":["mgmt","debug","none"],"type":"string","description":"Interface plane","title":"Interface plane"},"bond_cur_active_slave":{"readOnly":true,"type":"string","description":"Bond's currently active slave device","title":"Bond's currently active slave device"},"is_kni":{"readOnly":true,"type":"boolean","description":"Interface is a KNI","title":"Interface is a KNI"},"bond_lacp_rate":{"readOnly":true,"type":"string","description":"Bond's rate at which we'll ask our link partner to transmit LACPDU packets in 802.3ad mode","title":"Bond's rate at which we'll ask our link partner to transmit LACPDU packets in 802.3ad mode"},"ip_configuration":{"enum":["dhcp","static","not configured"],"type":"string","description":"Interface configuration","title":"Interface configuration"},"interface_id":{"readOnly":true,"type":"string","description":"Interface ID","title":"Interface ID"},"bond_xmit_hash_policy":{"readOnly":true,"enum":["layer2","layer2+3","layer3+4","encap2+3","encap3+4"],"type":"string","description":"Bond's transmit hash policy for balance-xor and 802.3ad modes","title":"Bond's transmit hash policy for balance-xor and 802.3ad modes"}}}],"description":"Node network interface properties","title":"Node network interface properties"},"TunnelStatusCount":{"x-vmw-nsx-module":"Heatmap","allOf":[{"$ref":"#/definitions/StatusCount"},{"x-vmw-nsx-module":"Heatmap","type":"object","properties":{"bfd_diagnostic":{"$ref":"#/definitions/BFDDiagnosticCount"},"bfd_status":{"$ref":"#/definitions/BFDStatusCount"}}}]},"RemoteServerFingerprint":{"description":"Remote server","title":"Remote server","required":["ssh_fingerprint","server"],"x-vmw-nsx-module":"BackupConfiguration","type":"object","properties":{"ssh_fingerprint":{"type":"string","description":"SSH fingerprint of server","title":"SSH fingerprint of server"},"port":{"description":"Server port","title":"Server port","default":22,"format":"int64","maximum":65535,"minimum":1,"type":"integer"},"server":{"format":"hostname-or-ip","type":"string","description":"Remote server hostname or IP address","title":"Remote server hostname or IP address"}}},"EdgeClusterInterSiteStatus":{"x-vmw-nsx-module":"AggSvcEdgeCluster","type":"object","properties":{"last_update_timestamp":{"description":"Timestamp when the edge cluster inter-site status was last updated.\n","format":"int64","readOnly":true,"type":"integer"},"overall_status":{"readOnly":true,"enum":["UP","DOWN","DEGRADED","UNKNOWN","CONFIGURED"],"type":"string","description":"Overall status of all edge nodes IBGP status in the edge cluster.\n","title":"Overall IBGP status in the edge cluster"},"edge_cluster_name":{"readOnly":true,"type":"string","description":"Name of the edge cluster whose status is being reported.","title":"Edge cluster name"},"member_status":{"items":{"$ref":"#/definitions/EdgeClusterMemberInterSiteStatus"},"readOnly":true,"type":"array","description":"Per edge node inter-site status.","title":"Per edge node inter-site status"},"edge_cluster_id":{"readOnly":true,"type":"string","description":"Id of the edge cluster whose status is being reported.","title":"Edge cluster id"}}},"Lag":{"description":"LACP group","title":"LACP group","required":["load_balance_algorithm","mode","name","number_of_uplinks"],"x-vmw-nsx-module":"UplinkHostSwitchProfile","type":"object","properties":{"uplinks":{"description":"uplink names","title":"uplink names","items":{"$ref":"#/definitions/Uplink"},"readOnly":true,"maxItems":32,"type":"array"},"name":{"type":"string","description":"Lag name","title":"Lag name"},"number_of_uplinks":{"description":"number of uplinks","format":"int32","title":"number of uplinks","maximum":32,"minimum":2,"type":"integer"},"timeout_type":{"default":"SLOW","enum":["SLOW","FAST"],"type":"string","description":"LACP timeout type","title":"LACP timeout type"},"load_balance_algorithm":{"enum":["SRCMAC","DESTMAC","SRCDESTMAC","SRCDESTIPVLAN","SRCDESTMACIPPORT"],"type":"string","description":"LACP load balance Algorithm","title":"LACP load balance Algorithm"},"id":{"readOnly":true,"type":"string","description":"unique id","title":"unique id"},"mode":{"enum":["ACTIVE","PASSIVE"],"type":"string","description":"LACP group mode","title":"LACP group mode"}}},"GlobalRestoreStatus":{"x-vmw-nsx-module":"ClusterRestore","type":"object","description":"Overall restore process status","properties":{"description":{"readOnly":true,"type":"string","description":"A description of the restore status","title":"A description of the restore status"},"value":{"readOnly":true,"enum":["INITIAL","SUCCESS","FAILED","RUNNING","SUSPENDED_BY_USER","SUSPENDED_FOR_USER_ACTION","SUSPENDED","ABORTED"],"type":"string","description":"Global rolled-up restore status value","title":"Global rolled-up restore status value"}},"title":"Overall restore process status"},"NSProfileListResult":{"x-vmw-nsx-module":"NSProfile","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"NSProfile","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/NSProfile"},"readOnly":true,"type":"array","description":"Paged collection of NSProfiles","title":"Paged collection of NSProfiles"}}}],"description":"List result of NSProfiles","title":"List result of NSProfiles"},"CopyFromRemoteFileProperties":{"x-vmw-nsx-module":"MISSING_MODULE","allOf":[{"$ref":"#/definitions/CopyRemoteFileProperties"},{"x-vmw-nsx-module":"MISSING_MODULE","required":["protocol"],"type":"object","properties":{"protocol":{"$ref":"#/definitions/Protocol"}}}]},"IPProtocolNSService":{"x-vmw-nsx-module":"Types","allOf":[{"$ref":"#/definitions/NSServiceElement"},{"required":["protocol_number"],"x-vmw-nsx-module":"Types","type":"object","properties":{"protocol_number":{"format":"int64","type":"integer","description":"The IP protocol number","title":"The IP protocol number"}}}],"description":"An NSService element that represents an IP protocol","title":"An NSService element that represents an IP protocol"},"Endpoint":{"x-vmw-nsx-module":"TransportNode","type":"object","description":"An Endpoint object is part of HostSwitch configuration in TransportNode","properties":{"subnet_mask":{"description":"Subnet mask","format":"ip","readOnly":true,"type":"string"},"mac":{"description":"MAC address","format":"mac-address","readOnly":true,"type":"string"},"default_gateway":{"description":"Gateway IP","format":"ip","readOnly":true,"type":"string"},"ip":{"description":"Depending upon the EndpointIpConfig used in HostSwitch, IP could be allocated either from DHCP (default) or from Static IP Pool.","format":"ip","readOnly":true,"type":"string"},"device_name":{"readOnly":true,"type":"string","description":"Name of the virtual tunnel endpoint","title":"Name of the virtual tunnel endpoint"},"label":{"readOnly":true,"format":"int32","type":"integer","description":"Unique label for this Endpoint","title":"Unique label for this Endpoint"}},"title":"Tunnel endpoint configuration"},"LbSessionCookieTime":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/LbCookieTime"},{"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"cookie_max_idle":{"description":"Instead of using HTTP Cookie max-age and relying on client to expire\nthe cookie, max idle time and/or max lifetime of the cookie can be used.\nMax idle time, if configured, specifies the maximum interval the cookie\nis valid for from the last time it was seen in a request.\nIt is available for insert mode.\n","format":"int64","title":"session cookie max idle time in seconds","maximum":2147483647,"minimum":1,"type":"integer"},"cookie_max_life":{"description":"Max life time, if configured, specifies the maximum interval the cookie\nis valid for from the first time the cookie was seen in a request.\nIt is available for insert mode.\n","format":"int64","title":"session cookie max lifetime in seconds","maximum":2147483647,"minimum":1,"type":"integer"}}}]},"ApiError":{"x-vmw-nsx-module":"Common","allOf":[{"$ref":"#/definitions/RelatedApiError"},{"x-vmw-nsx-module":"Common","type":"object","properties":{"related_errors":{"items":{"$ref":"#/definitions/RelatedApiError"},"type":"array","description":"Other errors related to this error","title":"Other errors related to this error"}}}],"description":"Detailed information about an API Error","title":"Detailed information about an API Error"},"LoadBalancerAllocationPool":{"x-vmw-nsx-module":"LogicalRouter","allOf":[{"$ref":"#/definitions/EdgeClusterMemberAllocationPool"},{"x-vmw-nsx-module":"LogicalRouter","required":["allocation_size"],"type":"object","properties":{"allocation_size":{"default":"SMALL","enum":["SMALL","MEDIUM","LARGE","XLARGE"],"type":"string","description":"To address varied customer performance and scalability requirements,\ndifferent sizes for load balancer service are supported: SMALL, MEDIUM,\nLARGE and XLARGE, each with its own set of resource and performance.\nSpecify size of load balancer service which you will bind to TIER1\nrouter.\n","title":"Size of load balancer service"}}}]},"StructuredData":{"description":"Structured data entry in RFC5424 log format","title":"Structured data entry in RFC5424 log format","required":["audit","comp","subcomp"],"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"audit":{"type":"string","description":"Audit flag of the log","title":"Audit flag of the log"},"username":{"type":"string","description":"Username value of the log","title":"Username value of the log"},"ereq_id":{"type":"string","description":"External request Id value of the log","title":"External request Id value of the log"},"level":{"type":"string","description":"Level value of the log","title":"Level value of the log"},"comp":{"type":"string","description":"Component value of the log","title":"Component value of the log"},"error_code":{"type":"string","description":"Error Code value of the log","title":"Error Code value of the log"},"s2comp":{"type":"string","description":"Sub-subcomponent value of the log","title":"Sub-subcomponent value of the log"},"req_id":{"type":"string","description":"Request Id value of the log","title":"Request Id value of the log"},"ent_id":{"type":"string","description":"Entity Id value of the log","title":"Entity Id value of the log"},"security":{"type":"string","description":"Security flag of the log","title":"Security flag of the log"},"subcomp":{"type":"string","description":"Subcomponent value of the log","title":"Subcomponent value of the log"}}},"InstanceRuntimeListResult":{"x-vmw-nsx-module":"ServiceInsertionVMDeployment","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"ServiceInsertionVMDeployment","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/InstanceRuntime"},"type":"array","description":"Array of existing InstanceRuntimes in database\n","title":"Results"}}}],"description":"Result of List of InstanceRuntimes","title":"InstanceRuntime list result"},"IpPoolListResult":{"x-vmw-nsx-module":"Ipam","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"Ipam","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/IpPool"},"type":"array","description":"IP pool list results","title":"IP pool list results"}}}]},"ClusterBackupInfoListResult":{"x-vmw-nsx-module":"ClusterRestore","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"ClusterRestore","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/ClusterBackupInfo"},"readOnly":true,"type":"array","description":"List of timestamps of backed-up cluster files","title":"List of timestamps of backed-up cluster files"}}}]},"DhcpHeader":{"x-vmw-nsx-module":"Traceflow","type":"object","properties":{"op_code":{"default":"BOOTREQUEST","enum":["BOOTREQUEST","BOOTREPLY"],"type":"string","description":"This is used to specify the general type of message. A client sending request to a server uses an op code of BOOTREQUEST, while a server replying uses an op code of BOOTREPLY.","title":"Message op code / message type"}}},"InterSiteBgpSummary":{"x-vmw-nsx-module":"AggSvcInterSite","type":"object","properties":{"last_update_timestamp":{"description":"Timestamp when the inter-site IBgp neighbors status was last updated.\n","format":"int64","readOnly":true,"type":"integer"},"neighbor_status":{"items":{"$ref":"#/definitions/BgpNeighborStatus"},"readOnly":true,"type":"array","description":"Status of all inter-site IBgp neighbors.","title":"Inter-site IBgp neighbors status"},"transport_node_id":{"readOnly":true,"type":"string","description":"Edge node id whose status is being reported.","title":"Edge node id"}}},"DropdownItem":{"description":"Dropdown item definition","title":"Dropdown item definition","required":["field","value"],"x-vmw-nsx-module":"NsxDashboard","type":"object","properties":{"field":{"type":"string","description":"An expression that represents the items of the dropdown filter.","title":"Expression for dropdown items of filter"},"short_display_name":{"maxLength":1024,"type":"string","description":"Property value is shown in the drop down input box for a filter. If the value is not provided 'display_name' property value is used.","title":"A property value to be shown once value is selected for a filter."},"display_name":{"maxLength":1024,"type":"string","description":"expression to extract display name to be shown in the drop down.","title":"Display name for item to be displayed in dropdown"},"additional_value":{"type":"object","description":"An additional key-value pair for item to be display in dropdown.","title":"An additional value for item to be display in dropdown."},"value":{"type":"string","description":"Value of filter inside dropdown filter.","title":"Value for item to be displayed in dropdown"}}},"GiServiceProfile":{"x-vmw-nsx-module":"ServiceInsertionCommonTypes","allOf":[{"$ref":"#/definitions/BaseServiceProfile"},{"required":["vendor_template_id"],"x-vmw-nsx-module":"ServiceInsertionCommonTypes","type":"object","properties":{"vendor_template_key":{"readOnly":true,"type":"string","description":"Different VMs in data center can have Different protection levels as specified by administrator in the policy. The identifier for the policy with which the partner appliance identifies this policy. This identifier will be passed to the partner appliance at runtime to specify which protection level is applicable for the VM being protected.","title":"Vendor template key"},"service_id":{"readOnly":true,"type":"string","description":"The service to which the service profile belongs.","title":"Service Id"},"vendor_template_id":{"readOnly":false,"type":"string","description":"ID of the vendor template, created by partner while registering the service.","title":"Vendor template Id"}}}],"description":"GI Specific service profile","title":"GI sepcific Service Profile"},"ExcludeList":{"x-vmw-nsx-module":"ExcludeList","allOf":[{"$ref":"#/definitions/DSExcludeList"},{"x-vmw-nsx-module":"ExcludeList","type":"object"}],"description":"List of entities where Distributed Firewall will not be enforced. Exclusion List can contain NSGroup(s) or LogicalPort(s) or LogicalSwitch(es) to exclude Distributed Firewall enforcement.","title":"Exclusion List"},"ManagedResource":{"x-vmw-nsx-module":"Common","allOf":[{"$ref":"#/definitions/RevisionedResource"},{"x-vmw-nsx-module":"Common","type":"object","properties":{"_system_owned":{"readOnly":true,"type":"boolean","description":"Indicates system owned resource"},"display_name":{"maxLength":255,"type":"string","description":"Defaults to ID if not set","title":"Identifier to use when displaying entity in logs or GUI"},"description":{"maxLength":1024,"type":"string","description":"Description of this resource","title":"Description of this resource"},"tags":{"items":{"$ref":"#/definitions/Tag"},"type":"array","description":"Opaque identifiers meaningful to the API user","maxItems":30,"title":"Opaque identifiers meaningful to the API user"},"_create_user":{"readOnly":true,"type":"string","description":"ID of the user who created this resource"},"_protection":{"readOnly":true,"type":"string","description":"Protection status is one of the following:\nPROTECTED - the client who retrieved the entity is not allowed\n to modify it.\nNOT_PROTECTED - the client who retrieved the entity is allowed\n to modify it\nREQUIRE_OVERRIDE - the client who retrieved the entity is a super\n user and can modify it, but only when providing\n the request header X-Allow-Overwrite=true.\nUNKNOWN - the _protection field could not be determined for this\n entity.\n","title":"Indicates protection status of this resource"},"_create_time":{"description":"Timestamp of resource creation","format":"int64","readOnly":true,"type":"integer"},"_last_modified_time":{"description":"Timestamp of last modification","format":"int64","readOnly":true,"type":"integer"},"_last_modified_user":{"readOnly":true,"type":"string","description":"ID of the user who last modified this resource"},"id":{"type":"string","description":"Unique identifier of this resource","title":"Unique identifier of this resource"},"resource_type":{"readOnly":false,"type":"string","description":"The type of this resource."}}}],"description":"Base type for resources that are managed by API clients","title":"Base type for resources that are managed by API clients"},"InstanceRuntime":{"x-vmw-nsx-module":"ServiceInsertionCommonTypes","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"ServiceInsertionCommonTypes","type":"object","properties":{"service_vm_id":{"readOnly":true,"type":"string","description":"Service-VM/SVM id of deployed virtual-machine.","title":"Service VM id"},"deployment_status":{"readOnly":true,"enum":["DEPLOYMENT_IN_PROGRESS","DEPLOYMENT_FAILED","DEPLOYMENT_SUCCESSFUL","UPGRADE_IN_PROGRESS","UPGRADE_FAILED","UNDEPLOYMENT_IN_PROGRESS","UNDEPLOYMENT_FAILED","UNDEPLOYMENT_SUCCESSFUL","UNKNOWN"],"type":"string","description":"Service-Instance Runtime deployment status of the Service-VM. It shows the latest status during the process of deployment, redeploy, upgrade, and un-deployment of VM.","title":"Instance Runtime deployment status"},"vm_nic_info":{"$ref":"#/definitions/VmNicInfo"},"maintenance_mode":{"readOnly":true,"enum":["OFF","ENTERING","ON","EXITING"],"type":"string","description":"The maintenance mode indicates whether the corresponding service VM\nis in maintenance mode. The service VM will not be used to service\nnew requests if it is in maintenance mode.\n","title":"Instance Runtime maintenance mode"},"runtime_status":{"readOnly":true,"enum":["IN_SERVICE","OUT_OF_SERVICE","NEEDS_ATTENTION","NOT_AVAILABLE"],"type":"string","description":"Service-Instance Runtime status of the deployed Service-VM.","title":"Instance Runtime Status"},"error_message":{"readOnly":true,"type":"string","description":"Error message for the Service Instance Runtime if any.","title":"Error Message"},"service_instance_id":{"readOnly":true,"type":"string","description":"Id of an instantiation of a registered service.","title":"Service instance id"},"runtime_health_status_by_partner":{"readOnly":true,"enum":["HEALTHY","STOPPED","NOT_RESPONDING"],"type":"string","description":"Service-Instance runtime health status set by partner to indicate\nwhether the service is running properly or not.\n","title":"Instance runtime health status set by partner"},"unhealthy_reason":{"readOnly":true,"type":"string","description":"Reason provided by partner for the service being unhealthy. This could be due\nto various reasons such as connectivity lost as an example.\n","title":"Reason for service status when unhealthy"}}}],"description":"A Service Runtime is the runtime entity associated with ever Service-VM deployed.","title":"Runtime of a Service-Instance."},"VlanTrunkSpec":{"description":"VlanTrunkspec is used for specifying trunk VLAN id ranges.","title":"VLAN trunk range specification","required":["vlan_ranges"],"x-vmw-nsx-module":"LogicalSwitch","type":"object","properties":{"vlan_ranges":{"items":{"$ref":"#/definitions/TrunkVlanRange"},"type":"array","description":"Trunk VLAN id ranges","title":"Trunk VLAN id ranges"}}},"CopyRemoteFileProperties":{"x-vmw-nsx-module":"MISSING_MODULE","required":["uri","server"],"type":"object","properties":{"uri":{"type":"string","description":"URI of file to copy","title":"URI of file to copy"},"port":{"description":"Server port","format":"int64","title":"Server port","maximum":65535,"minimum":1,"type":"integer"},"server":{"type":"string","description":"Remote server hostname or IP address","title":"Remote server hostname or IP address"}}},"NodeNameServersProperties":{"x-vmw-nsx-module":"MISSING_MODULE","allOf":[{"$ref":"#/definitions/Resource"},{"required":["name_servers"],"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"name_servers":{"items":{"type":"string"},"type":"array","description":"Name servers","maxItems":3,"title":"Name servers"}}}],"description":"Node network name servers properties","title":"Node network name servers properties"},"ServiceInstanceNSGroups":{"x-vmw-nsx-module":"ServiceInsertionCommonTypes","type":"object","description":"ServiceInstanceNSGroups contains list of NS Groups referenced in North-South Service Insertion Rules for a particular Service Instance.","properties":{"nsroups":{"items":{"$ref":"#/definitions/NSGroupInfo"},"readOnly":true,"type":"array","description":"List of NSGroups Used in ServiceInsertion Rules.","title":"NSGroup List"}},"title":"NSGroups referenced in North-South Service Instance"},"LbHttpRequestBodyCondition":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/LbRuleCondition"},{"required":["body_value"],"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"body_value":{"type":"string","description":"HTTP request body","title":"HTTP request body"},"match_type":{"description":"Match type of HTTP body","default":"REGEX","enum":["STARTS_WITH","ENDS_WITH","EQUALS","CONTAINS","REGEX"],"type":"string"},"case_sensitive":{"default":true,"type":"boolean","description":"If true, case is significant when comparing HTTP body value.\n","title":"A case sensitive flag for HTTP body comparing"}}}],"description":"This condition is used to match the message body of an HTTP request.\nTypically, only HTTP POST, PATCH, or PUT requests have request body.\nThe match_type field defines how body_value field is used to match the body\nof HTTP requests.\n","title":"Condition to match content of HTTP request message body"},"KeyValue":{"x-vmw-nsx-module":"CertificateManager","required":["value","key"],"type":"object","properties":{"value":{"readOnly":false,"type":"string","description":"Key value."},"key":{"readOnly":false,"type":"string","description":"Key name."}}},"AlarmsListResult":{"x-vmw-nsx-module":"Monitoring","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"Monitoring","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/Alarm"},"readOnly":true,"type":"array","description":"List of alarms known to the system","title":"List of alarms known to the system"}}}]},"PhysicalServer":{"x-vmw-nsx-module":"PhysicalServer","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"PhysicalServer","type":"object","properties":{"os_type":{"readOnly":true,"enum":["RHELSERVER","UBUNTUSERVER","CENTOSSERVER","SLESSERVER","WINDOWSSERVER","OELSERVER"],"type":"string","description":"OS type of the physical server.","title":"OS type of the physical server"},"ip_addresses":{"items":{"description":"IPv4 or IPv6 address","format":"ip","type":"string"},"readOnly":true,"type":"array","description":"IP addresses of the physical server specified by the admin while registering as Transport node in nsx.","title":"IP Addresses of the physical server, version 4 or 6"}}}],"description":"Details of physical/bare metal server. PhysicalServer is an abstraction for TransportNode with os_type RHELSERVER, UBUNTUSERVER, CENTOSSERVER, SLESSERVER, OELSERVER or WINDOWSSERVER. This entity will be used in grouping to provide micro-segmentation to physical servers. To add any new physical servers/perform any changes, use create/update TransportNode API.","title":"Physical server"},"VidmInfoListResult":{"x-vmw-nsx-module":"AAA","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"AAA","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/VidmInfo"},"type":"array","description":"List results","title":"List results"}}}]},"RemoteSiteCompatibilityInfo":{"x-vmw-nsx-module":"SiteManagerModule","type":"object","properties":{"remote_site":{"$ref":"#/definitions/SiteCompatibilityInfo"},"is_compatible":{"type":"boolean","description":"are the 2 sites compatible","title":"are the 2 sites compatible"},"local_site":{"$ref":"#/definitions/SiteCompatibilityInfo"}}},"TransportNodeStatusListResult":{"x-vmw-nsx-module":"Heatmap","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"Heatmap","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/TransportNodeStatus"},"type":"array","description":"List of transport node statuses","title":"List of transport node statuses"}}}]},"RedistributionRule":{"x-vmw-nsx-module":"Routing","required":["sources"],"type":"object","properties":{"sources":{"items":{"description":"Types of route to redistribute over routing protocols.\nSTATIC type is deprecated, use T0_STATIC instead.\nT0_STATIC type should be used to redistribute user added static\nroutes.\nNSX_CONNECTED type is deprecated, use T0_CONNECTED instead.\nFor backward compatibility when NSX_CONNECTED is selected,\nwe will redistribute downlink port subnets for TIER0 LR.\nT0_CONNECTED type should be used to redistribute all port\nsubnets including uplink, downlink, CSP and loopback for TIER0 LR.\nNSX_STATIC type is deprecated, use T1_STATIC instead.\nFor backward compatibility when NSX_STATIC is selected,\nwe will redistribute static, CSP and downlink port subnets\nadvertised by TIER1 LR.\nT1_STATIC type should be used to redistribute static subnets\nadvertised by TIER1 LR.\nT0_UPLINK type should be used to redistribute uplink port subnets\non TIER0 LR.\nT0_DOWNLINK type should be used to redistribute downlink port subnets\non TIER0 LR.\nT0_ROUTER_LINK type should be used to redistribute router link port\nsubnets on TIER0 LR\nT0_CSP type should be used to redistribute centralised service port\nsubnets on TIER0 LR.\nT0_LOOPBACK type should be used to redistribute loopback port subnets\non TIER0 LR.\nT0_DNS_FORWARDER_IP type should be used to redistribute DNS forwarder\nsubnets on TIER0 LR.\nT0_IPSEC_LOCAL_IP type should be used to redistribute IPSec subnets\non TIER0 LR.\nTIER0_NAT type is deprecated, use T0_NAT instead.\nT0_NAT type should be used to redistribute NAT IPs owned by\nTIER0 logical router.\nTIER1_NAT type is deprecated, use T1_NAT instead.\nT1_NAT type should be used to redistribute NAT IP subnets advertised\nby TIER1 LR.\nTIER1_LB_VIP type is deprecated,use T1_LB_VIP instead.\nT1_LB_VIP type should be used to redistribute LB VIP IP subnets\nadvertised by TIER1 LR.\nTIER1_LB_SNAT type is deprecated, use T1_NAT instead.\nT1_LB_SNAT type should be used to redistribute LB SNAT IP subnets\nadvertised by TIER1 LR.\nT1_DNS_FORWARDER_IP type should be used to redistribute DNS forwarder\nsubnets advertised by TIER1 LR.\nT1_CONNECTED type should be used to redistribute downlink and CSP port\nsubnets advertised by TIER1 LR.\nT1_DOWNLINK type should be used to redistribute downlink port\nsubnets advertised by TIER1 LR.\nT1_CSP type should be used to redistribute centralised service port\nsubnets advertised by TIER1 LR.\nBGP type should be used to redistribute routes learned via BGP.\nT1_IPSEC_LOCAL_IP type should be used to redistribute IPSec VPN local\nendpoint subnets advertised by TIER1 LR.\nT0_EVPN_TEP_IP type should be used to redistribute EVPN local endpoint\nsubnets on Tier0 LR.\n","enum":["STATIC","T0_STATIC","NSX_CONNECTED","T0_CONNECTED","NSX_STATIC","T1_STATIC","T0_UPLINK","T0_DOWNLINK","T0_ROUTER_LINK","T0_CSP","T0_LOOPBACK","T0_DNS_FORWARDER_IP","T0_IPSEC_LOCAL_IP","TIER0_NAT","T0_NAT","TIER1_NAT","T1_NAT","TIER1_LB_VIP","T1_LB_VIP","TIER1_LB_SNAT","T1_LB_SNAT","T1_DNS_FORWARDER_IP","T1_CONNECTED","T1_DOWNLINK","T1_CSP","BGP","T1_IPSEC_LOCAL_IP","T0_EVPN_TEP_IP"],"type":"string"},"type":"array","description":"Array of redistribution protocols","title":"Array of redistribution protocols"},"route_map_id":{"type":"string","description":"RouteMap Id for the filter","title":"RouteMap Id for the filter"},"address_family":{"description":"Address family for Route Redistribution","title":"Address family for Route Redistribution","default":"IPV4_AND_IPV6","enum":["IPV4","IPV6","IPV4_AND_IPV6"],"readOnly":true,"type":"string"},"display_name":{"maxLength":255,"type":"string","description":"Display name","title":"Display name"},"destination":{"description":"Destination redistribution protocol","enum":["STATIC","T0_STATIC","NSX_CONNECTED","T0_CONNECTED","NSX_STATIC","T1_STATIC","T0_UPLINK","T0_DOWNLINK","T0_ROUTER_LINK","T0_CSP","T0_LOOPBACK","T0_DNS_FORWARDER_IP","T0_IPSEC_LOCAL_IP","TIER0_NAT","T0_NAT","TIER1_NAT","T1_NAT","TIER1_LB_VIP","T1_LB_VIP","TIER1_LB_SNAT","T1_LB_SNAT","T1_DNS_FORWARDER_IP","T1_CONNECTED","T1_DOWNLINK","T1_CSP","BGP","T1_IPSEC_LOCAL_IP","T0_EVPN_TEP_IP"],"type":"string"},"description":{"maxLength":1024,"type":"string","description":"Description","title":"Description"}}},"HealthCheckResultOnHostSwitch":{"x-vmw-nsx-module":"HealthCheck","type":"object","description":"Health check result on specific host switch of specific transport node.\n","properties":{"vlan_mtu_status":{"description":"Status of VLAN-MTU health check result on host switch.\n","enum":["TRUNKED","UNTRUNKED","UNKNOWN"],"readOnly":true,"type":"string"},"host_switch_name":{"readOnly":true,"type":"string","description":"Name of the host switch.","title":"Host Switch Name"},"results_per_uplink":{"items":{"$ref":"#/definitions/HealthCheckResultPerUplink"},"readOnly":true,"type":"array","description":"List of health check results per uplink on current host switch of specific\ntransport node.\n","title":"Health Check Results Per uplink"},"updated_time":{"description":"Timestamp of check result updated.","format":"int64","readOnly":true,"type":"integer"}},"title":"Health Check Result On Host Switch"},"MigrationDataInfo":{"x-vmw-nsx-module":"Migration","type":"object","properties":{"file_type":{"readOnly":true,"enum":["VRA_INPUT","VRA_OUTPUT","EDGE_CUTOVER_MAPPING","BYOT_L3_MAPPING","AVI_LB_MAPPING"],"type":"string","description":"Type of the Migration data file for which info is requested.","title":"Type of the Migration data file for which info is requested."},"file_location":{"readOnly":true,"type":"string","description":"Absolute location of the file.","title":"Absolute location of the file."},"federation_site_id":{"readOnly":true,"type":"string","description":"Id of the site in NSX-T Federation","title":"Id of the site in NSX-T Federation"},"is_present":{"readOnly":true,"type":"boolean","description":"Indicates if the file is present.","title":"Indicates if the file is present."}}},"LbMonitor":{"x-vmw-nsx-module":"LoadBalancer","description":"The object is deprecated as NSX-T Load Balancer is deprecated.\n","allOf":[{"$ref":"#/definitions/ManagedResource"},{"required":["resource_type"],"discriminator":"resource_type","x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"resource_type":{"description":"Load balancers monitor the health of backend servers to ensure traffic\nis not black holed.\nThere are two types of healthchecks: active and passive.\nPassive healthchecks depend on failures in actual client traffic (e.g. RST\nfrom server in response to a client connection) to detect that the server\nor the application is down.\nIn case of active healthchecks, load balancer itself initiates new\nconnections (or sends ICMP ping) to the servers periodically to check their\nhealth, completely independent of any data traffic.\nCurrently, active health monitors are supported for HTTP, HTTPS, TCP, UDP\nand ICMP protocols.\n","enum":["LbHttpMonitor","LbHttpsMonitor","LbIcmpMonitor","LbTcpMonitor","LbUdpMonitor","LbPassiveMonitor"],"type":"string"}}}]},"DirectoryLdapServer":{"x-vmw-nsx-module":"DirectoryService","allOf":[{"$ref":"#/definitions/ManagedResource"},{"required":["host"],"x-vmw-nsx-module":"DirectoryService","type":"object","properties":{"username":{"type":"string","description":"Directory LDAP server connection user name.","title":"LDAP server username"},"host":{"format":"hostname-or-ip","type":"string","description":"Directory LDAP server DNS host name or ip address which is reachable by NSX manager to be connected and do object synchronization.","title":"LDAP server host name"},"protocol":{"default":"LDAP","enum":["LDAP","LDAPS"],"type":"string","description":"Directory LDAP server connection protocol which is either LDAP or LDAPS.","title":"LDAP server protocol"},"thumbprint":{"type":"string","description":"Directory LDAP server certificate thumbprint used in secure LDAPS connection.","title":"LDAP server certificate thumbprint using SHA-256 algorithm"},"password":{"type":"string","description":"Directory LDAP server connection password.","title":"LDAP server password"},"domain_name":{"type":"string","description":"Directory domain name which best describes the domain. It could be unique fqdn name or it could also be descriptive. There is no unique contraint for domain name among different domains.","title":"Directory domain name"},"port":{"default":389,"format":"int64","type":"integer","description":"Directory LDAP server connection TCP/UDP port.","title":"LDAP server TCP/UDP port"}}}],"description":"LDAP server of directory domain","title":"LDAP server of directory domain"},"TokenBasedPrincipalIdentity":{"x-vmw-nsx-module":"CertificateManager","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"CertificateManager","required":["node_id","name"],"type":"object","properties":{"node_id":{"readOnly":false,"maxLength":255,"type":"string","description":"Unique node-id of a principal. This is used primarily in the case\nwhere a cluster of nodes is used to make calls to the NSX Manager and\nthe same 'name' is used so that the nodes can access and modify the\nsame data while still accessing NSX through their individual secret\n(certificate or JWT). In all other cases this can be any string.\n","title":"Unique node-id"},"name":{"readOnly":false,"maxLength":255,"type":"string","description":"Name of the principal. This will be matched to the name provided in the token.","title":"Name"},"is_protected":{"readOnly":false,"type":"boolean","description":"Indicator whether the entities created by this principal should be protected.","title":"Protection indicator"}}}]},"ByodServiceInstance":{"x-vmw-nsx-module":"ServiceInsertionCommonTypes","allOf":[{"$ref":"#/definitions/BaseServiceInstance"},{"required":["deployment_mode"],"x-vmw-nsx-module":"ServiceInsertionCommonTypes","type":"object","properties":{"deployment_mode":{"description":"Deployment mode specifies where the partner appliance will be deployed in HA or non-HA i.e standalone mode.","title":"Deployment Mode","default":"ACTIVE_STANDBY","enum":["STAND_ALONE","ACTIVE_STANDBY"],"readOnly":false,"type":"string"}}}],"description":"ByodServiceInstance is a custom instance to be used when NSX is not handling the lifecycles of appliance/s. User will manage their own appliance (BYOD) to connect with NSX.","title":"Custom Instance of a service"},"LogicalRouterState":{"x-vmw-nsx-module":"LogicalRouter","allOf":[{"$ref":"#/definitions/EdgeConfigurationState"},{"x-vmw-nsx-module":"LogicalRouter","type":"object"}],"description":"This holds the state of Logical Router. If there are errors in realizing LR outside of MP, it gives details of the components and specific errors.","title":"Realization State of Logical Router."},"VtepListResult":{"x-vmw-nsx-module":"AggSvcLogicalSwitch","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"AggSvcLogicalSwitch","type":"object","properties":{"last_update_timestamp":{"description":"Timestamp when the data was last updated; unset if data source has never updated the data.","format":"int64","readOnly":true,"type":"integer"},"logical_switch_id":{"readOnly":true,"type":"string","description":"The id of the logical Switch","title":"The id of the logical Switch"},"results":{"items":{"$ref":"#/definitions/VtepTableEntry"},"type":"array"},"transport_node_id":{"readOnly":true,"type":"string","description":"Transport node identifier","title":"Transport node identifier"}}}]},"NodeInfo":{"x-vmw-nsx-module":"Migration","allOf":[{"$ref":"#/definitions/Resource"},{"x-vmw-nsx-module":"Migration","type":"object","properties":{"type":{"readOnly":true,"type":"string","description":"Node type","title":"Node type"},"display_name":{"readOnly":true,"type":"string","description":"Name of the node","title":"Name of the node"},"id":{"readOnly":true,"type":"string","description":"Identifier of the node","title":"UUID of node"},"component_version":{"readOnly":true,"type":"string","description":"Component version of the node","title":"Component version of the node"}}}]},"FirewallProfileListResult":{"x-vmw-nsx-module":"FirewallProfile","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"FirewallProfile","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/BaseFirewallProfile"},"readOnly":true,"type":"array","description":"List of firewall profiles.","title":"List of the firewall profiles"}}}]},"DSService":{"x-vmw-nsx-module":"DistributedServices","allOf":[{"$ref":"#/definitions/ResourceReference"},{"x-vmw-nsx-module":"DistributedServices","type":"object","properties":{"service":{"$ref":"#/definitions/NSServiceElement"}}}]},"ContainerClusterStatusList":{"x-vmw-nsx-module":"TnContainerStatus","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"TnContainerStatus","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/ContainerClusterSummary"},"readOnly":true,"type":"array","description":"Container cluster list.","title":"Container cluster list"}}}],"description":"List of the Container cluster","title":"List of the Container cluster"},"ApplianceLatencyDataItem":{"x-vmw-nsx-module":"ShaApplianceMonitor","type":"object","description":"Describes appliance latency data in detail.\n","properties":{"status":{"enum":["UP","DOWN"],"type":"string","description":"Display the connection status between source node and destination node.\n","title":"Display the connection status"},"packet_transmitted":{"format":"int64","type":"integer","description":"Display the transmitted packets in Ping","title":"Display the transmitted packets"},"destination_node_id":{"type":"string","description":"Display the appliance node id.","title":"Node id"},"destination_node_ip":{"type":"string","description":"Display the appliance node ip.","title":"Node name"},"rtt_avg":{"type":"number","description":"Display the average Round Trip Time in milliseconds.\n","title":"Display the average rtt of latency value"},"source_node_ip":{"type":"string","description":"Display the appliance node ip.","title":"Node name"},"packet_loss_percent":{"type":"string","description":"Display the percentage of lost packet.","title":"Display the percentage of lost packet"},"rtt_min":{"type":"number","description":"Display the min Round Trip Time in milliseconds.\n","title":"Display the min rtt of latency value"},"rtt_max":{"type":"number","description":"Display the max Round Trip Time in milliseconds.\n","title":"Display the max rtt of latency value"},"total_time":{"format":"int64","type":"integer","description":"Display the total time of sending and receiving packets in milliseconds.\n","title":"Display the total time in milliseconds"},"packet_received":{"format":"int64","type":"integer","description":"Display the received packets.","title":"Display the received packets"},"destination_node_name":{"type":"string","description":"Display the appliance node name.","title":"Node name"},"rtt_mdev":{"type":"number","description":"Display the mean Round Trip Time in milliseconds.\n","title":"Display the mean rtt of latency value"}},"title":"Appliance Latency data"},"SuccessNodeSupportBundleResult":{"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"bundle_name":{"readOnly":true,"type":"string","description":"Name of support bundle, e.g. nsx_NODETYPE_UUID_YYYYMMDD_HHMMSS.tgz","title":"Name of support bundle, e.g. nsx_NODETYPE_UUID_YYYYMMDD_HHMMSS.tgz"},"node_display_name":{"readOnly":true,"type":"string","description":"Display name of node","title":"Display name of node"},"node_id":{"readOnly":true,"type":"string","description":"UUID of node","title":"UUID of node"},"sha256_thumbprint":{"readOnly":true,"type":"string","description":"File's SHA256 thumbprint","title":"File's SHA256 thumbprint"},"bundle_size":{"readOnly":true,"format":"int64","type":"integer","description":"Size of support bundle in bytes","title":"Size of support bundle in bytes"}}},"MigrationUnitGroupListResult":{"x-vmw-nsx-module":"Migration","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"Migration","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/MigrationUnitGroup"},"type":"array","description":"Paged Collection of Migration unit groups","title":"Paged Collection of Migration unit groups"}}}]},"ClusterRoleConfig":{"x-vmw-nsx-module":"ClusterManagement","type":"object","properties":{"type":{"readOnly":true,"enum":["ManagementClusterRoleConfig","ControllerClusterRoleConfig"],"type":"string","description":"Type of this role configuration","title":"Type of this role configuration"}}},"OvfInfo":{"x-vmw-nsx-module":"FileUploadFramework","type":"object","description":"Information related to OVF file.","properties":{"version":{"readOnly":true,"type":"string","description":"Version of the OVF.","title":"OVF version"},"ovf_name":{"readOnly":true,"type":"string","description":"Name of OVF file.","title":"OVF file name"}},"title":"OVF Information"},"IDSEventsBySignature":{"x-vmw-nsx-module":"IDSMetrics","allOf":[{"$ref":"#/definitions/Resource"},{"x-vmw-nsx-module":"IDSMetrics","type":"object","properties":{"count":{"readOnly":true,"format":"int64","type":"integer","description":"Number of times this particular signature was detected.","title":"Number of times signature was seen"},"first_occurence":{"description":"First occurence of the intrusion, in epoch milliseconds.","format":"int64","readOnly":true,"type":"integer"},"severity":{"readOnly":true,"type":"string","description":"Severity of the threat covered by the signature, can be Critical, High, Medium, or Low.","title":"Severity of the signature"},"signature_name":{"readOnly":true,"type":"string","description":"Name of the signature pertaining to the detected intrusion.","title":"Name of the signature"},"is_ongoing":{"readOnly":true,"type":"boolean","description":"Flag indicating an ongoing intrusion.","title":"Flag indicating an ongoing intrusion"},"signature_id":{"readOnly":true,"format":"int64","type":"integer","description":"Signature ID pertaining to the detected intrusion.","title":"Signature ID"},"resource_type":{"readOnly":true,"type":"string","description":"IDSEvent resource type.","title":"IDSEvent resource type"}}}],"description":"Intrusions that are detected, grouped by signature. It contains the signature id,\nseverity, name, the number of intrusions of that type and the first occurence.\n","title":"Detcted intrusions grouped by signature"},"NotificationWatcherListResult":{"x-vmw-nsx-module":"NfwConfig","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"NfwConfig","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/NotificationWatcher"},"readOnly":true,"type":"array","description":"List of notification watchers","title":"List of notification watchers"}}}]},"EdgeClusterMemberInterSiteStatus":{"x-vmw-nsx-module":"AggSvcEdgeCluster","type":"object","properties":{"transport_node":{"$ref":"#/definitions/ResourceReference"},"established_bgp_sessions":{"readOnly":true,"format":"int64","type":"integer","description":"Total number of current established inter-site IBGP sessions.","title":"Established inter-site IBGP sessions"},"status":{"readOnly":true,"enum":["UP","DOWN","DEGRADED","UNKNOWN"],"type":"string","description":"Edge node IBGP status","title":"Edge node IBGP status"},"total_bgp_sessions":{"readOnly":true,"format":"int64","type":"integer","description":"Total number of inter-site IBGP sessions.","title":"Total inter-site IBGP sessions"},"neighbor_status":{"items":{"$ref":"#/definitions/BgpNeighborStatusLiteDto"},"readOnly":true,"type":"array","description":"Inter-site BGP neighbor status.","title":"BGP neighbor status"}}},"ServiceEndpoint":{"x-vmw-nsx-module":"ClusterManagement","required":["ip_address","port"],"type":"object","properties":{"certificate_sha256_thumbprint":{"readOnly":true,"type":"string"},"certificate":{"type":"string","description":"Certificate or certificate chain","title":"Certificate or certificate chain"},"entities_hosted":{"items":{"$ref":"#/definitions/HostedEntityInfo"},"readOnly":true,"type":"array","description":"List of entities hosted on accessible through the service endpoint","title":"List of entities hosted on accessible through the service endpoint"},"ip_address":{"description":"IPv4 or IPv6 address","format":"ip","type":"string"},"fqdn":{"readOnly":true,"type":"string"},"service_endpoint_uuid":{"readOnly":true,"type":"string","description":"Unique identifier of this service endpoint","title":"Unique identifier of this service endpoint"},"port":{"minimum":0,"type":"integer","maximum":65535,"format":"int64"}}},"Certificate":{"x-vmw-nsx-module":"CertificateManager","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"CertificateManager","required":["pem_encoded"],"type":"object","properties":{"purpose":{"readOnly":false,"enum":["signing-ca"],"type":"string","description":"Purpose of this certificate. Can be empty or set to \"signing-ca\"."},"used_by":{"items":{"$ref":"#/definitions/NodeIdServicesMap"},"readOnly":true,"type":"array","description":"List of node IDs with services, that are using this certificate."},"details":{"items":{"$ref":"#/definitions/X509Certificate"},"readOnly":true,"type":"array","description":"List of X509Certificates."},"pem_encoded":{"readOnly":false,"type":"string","description":"PEM encoded certificate data."},"has_private_key":{"default":false,"readOnly":true,"type":"boolean","description":"Whether we have the private key for this certificate."}}}]},"NicMetadata":{"description":"Information on the Network interfaces present on the partner appliance that needs to be configured by the NSX Manager.","title":"NIC Metadata","required":["interface_label","interface_type","interface_index"],"x-vmw-nsx-module":"ServiceInsertionCommonTypes","type":"object","properties":{"interface_label":{"readOnly":false,"type":"string","description":"Network Interface label.","title":"Interface label"},"interface_type":{"readOnly":false,"enum":["MANAGEMENT","DATA1","DATA2","HA1","HA2","CONTROL"],"type":"string","description":"Interface that needs to be configured on the partner appliance. Ex. MANAGEMENT, DATA1, DATA2, HA1, HA2, CONTROL.","title":"Interface type"},"transports":{"description":"Transport Type of the service, which is the mechanism of redirecting the traffic to the the partner appliance. Transport type is required if Service caters to any functionality other than EPP and MPS. Here, the transports array specifies the kinds of transport where this particular NIC is user configurable. If nothing is specified, and the \"user_configurable\" flag is true, then user configuration will be allowed for all transports. If any transport is/are specified, then it will be considered as user configurable for the specified transports only.\"","title":"Transport Type","minItems":0,"items":{"enum":["L2_BRIDGE","L3_ROUTED","NSH"],"type":"string"},"readOnly":false,"maxItems":3,"type":"array"},"user_configurable":{"readOnly":false,"type":"boolean","description":"Used to specify if the given interface needs configuration. Management nics will always need the configuration, for others it will be use case specific. For example, a DATA NIC may be user configurable if the appliance is deployed in certain mode, such as L3_ROUTED.","title":"Required Configuration"},"interface_index":{"description":"Network Interface index.","format":"int64","title":"Interface Index","readOnly":false,"minimum":0,"type":"integer"}}},"LbRuleListResult":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"LoadBalancer","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/LbRule"},"type":"array","description":"paginated list of LB rules","title":"paginated list of LB rules"}}}]},"ProcessInformation":{"x-vmw-nsx-module":"ShaApplianceMonitor","type":"object","description":"Describes a process detail informaiton.\n","properties":{"process_id":{"type":"string","description":"Display the process id.","title":"Process id"},"shared_memory_size":{"type":"number","description":"The amount of shared memory available to a process, not all of which is typically resident.\nIt simply reflects memory that could be potentially shared with other processes.\n","title":"Shared Memory Size (MB)"},"command":{"type":"string","description":"Display the command line used to start the process.","title":"Display process command"},"memory_usage":{"type":"number","description":"A process's currently used share of available physical memory.\n","title":"Memory usage"},"virtual_memory_size":{"type":"number","description":"The total amount of virtual memory used by the process.\nIt includes all code, data and shared libraries plus pages that have been swapped out and pages that have been mapped but not used.\n","title":"Virtual Memory Size (MB)"},"resident_memory_size":{"type":"number","description":"The non-swapped physical memoery a task is using.","title":"Resident Memory Size (MB)"},"nice_value":{"type":"string","description":"A negative nice value means higher priority, whereas a positive nice value means lower priority.\nZero in this field simply means priority will not be adjusted in determining a process's dispatch-ability.\n","title":"The nice value of the process"},"cpu_usage":{"type":"number","description":"The process's share of the elapsed CPU time since the last screen update, expressed as a percentage of total CPU time.\n","title":"CPU usage"},"user":{"type":"string","description":"Display the process user.","title":"Process user"}},"title":"Process information"},"TraceflowListResult":{"x-vmw-nsx-module":"Traceflow","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"Traceflow","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/Traceflow"},"readOnly":true,"type":"array","description":"Traceflow Results","title":"Traceflow Results"}}}],"description":"Traceflow queries result","title":"Traceflow queries result"},"FirewallStatsList":{"x-vmw-nsx-module":"FirewallStatsRule","type":"object","properties":{"result_count":{"readOnly":true,"format":"int64","type":"integer","description":"Total count for firewall rule statistics in results set","title":"Firewall rules stats count"},"section_id":{"readOnly":true,"type":"string","description":"Corresponding firewall section identifier for list of rule statistics","title":"Firewall section ID"},"results":{"description":"List of rule statistics","title":"Firewall rules stats","items":{"$ref":"#/definitions/FirewallStats"},"readOnly":true,"maxItems":1000,"type":"array"}}},"NodeRouteProperties":{"x-vmw-nsx-module":"MISSING_MODULE","allOf":[{"$ref":"#/definitions/Resource"},{"required":["route_type"],"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"src":{"type":"string","description":"Source address to prefer when sending to destinations of route","title":"Source address to prefer when sending to destinations of route"},"from_address":{"type":"string","description":"From address","title":"From address"},"proto":{"default":"boot","enum":["unspec","redirect","kernel","boot","static","gated","ra","mrt","zebra","bird","dnrouted","xorp","ntk","dhcp"],"type":"string","description":"Routing protocol identifier of route","title":"Routing protocol identifier of route"},"route_type":{"enum":["default","static","blackhole","prohibit","throw","unreachable"],"type":"string","description":"Route type","title":"Route type"},"metric":{"type":"string","description":"Metric value of route","title":"Metric value of route"},"destination":{"type":"string","description":"Destination covered by route","title":"Destination covered by route"},"interface_id":{"type":"string","description":"Network interface id of route","title":"Network interface id of route"},"route_id":{"readOnly":true,"type":"string","description":"Unique identifier for the route","title":"Unique identifier for the route"},"netmask":{"type":"string","description":"Netmask of destination covered by route","title":"Netmask of destination covered by route"},"scope":{"type":"string","description":"Scope of destinations covered by route","title":"Scope of destinations covered by route"},"gateway":{"type":"string","description":"Address of next hop","title":"Address of next hop"}}}],"description":"Node network route properties","title":"Node network route properties"},"SupportedHostOSListResult":{"x-vmw-nsx-module":"HostPrepServiceFabric","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"HostPrepServiceFabric","type":"object","properties":{"results":{"items":{"type":"string"},"readOnly":true,"type":"array","description":"Supported host OS list results","title":"Supported host OS list results"}}}],"description":"REST interface for supported host OS types.","title":"Supported host OS list result"},"NodeRoutePropertiesListResult":{"x-vmw-nsx-module":"MISSING_MODULE","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/NodeRouteProperties"},"type":"array","description":"Node route property results","title":"Node route property results"}}}],"description":"Node network route properties list results","title":"Node network route properties list results"},"Ipv4Header":{"x-vmw-nsx-module":"Traceflow","type":"object","properties":{"src_ip":{"description":"The source ip address.","format":"ipv4","type":"string"},"flags":{"description":"IP flags","title":"IP flags","default":0,"format":"int64","maximum":8,"minimum":0,"type":"integer"},"dst_ip":{"description":"The destination ip address.","format":"ipv4","type":"string"},"src_subnet_prefix_len":{"description":"This is used together with src_ip to calculate dst_ip for broadcast when dst_ip is not given; not used in all other cases.","format":"int64","title":"source subnet prefix length.","maximum":32,"minimum":1,"type":"integer"},"ttl":{"description":"Time to live (ttl)","title":"Time to live (ttl)","default":64,"format":"int64","maximum":255,"minimum":0,"type":"integer"},"protocol":{"description":"IP protocol - defaults to ICMP","title":"IP protocol - defaults to ICMP","default":1,"format":"int64","maximum":255,"minimum":0,"type":"integer"}}},"EULAContent":{"x-vmw-nsx-module":"EULA","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"EULA","type":"object","properties":{"content":{"type":"string","description":"Content of End User License Agreement","title":"End User License Agreement content"}}}],"description":"End User License Agreement content","title":"EULA content"},"PktcapActionConfig":{"x-vmw-nsx-module":"LiveTrace","type":"object","properties":{"sampling_argument":{"$ref":"#/definitions/SamplingArgument"},"action_argument":{"$ref":"#/definitions/PktcapActionArgument"}}},"NodeInterfaceAlias":{"x-vmw-nsx-module":"ApplianceStats","type":"object","description":"Node network interface alias","properties":{"ip_configuration":{"enum":["dhcp","static","not configured"],"type":"string","description":"Interface configuration","title":"Interface configuration"},"netmask":{"type":"string","description":"Interface netmask","title":"Interface netmask"},"ip_address":{"description":"Interface IP address","format":"ip","type":"string"},"physical_address":{"description":"Interface MAC address","format":"mac-address","type":"string"},"broadcast_address":{"description":"Interface broadcast address","format":"ip","type":"string"}},"title":"Node network interface alias"},"MacManagementSwitchingProfile":{"x-vmw-nsx-module":"MacManagementSwitchingProfile","allOf":[{"$ref":"#/definitions/BaseSwitchingProfile"},{"x-vmw-nsx-module":"MacManagementSwitchingProfile","type":"object","properties":{"mac_learning":{"$ref":"#/definitions/MacLearningSpec"},"mac_change_allowed":{"default":false,"readOnly":false,"type":"boolean","description":"Allowing source MAC address change","title":"Allowing source MAC address change"}}}]},"ContainerApplication":{"x-vmw-nsx-module":"InventoryContainerObj","allOf":[{"$ref":"#/definitions/DiscoveredResource"},{"required":["external_id"],"x-vmw-nsx-module":"InventoryContainerObj","type":"object","properties":{"status":{"readOnly":false,"enum":["UNKNOWN","HEALTHY","UP","DOWN","DEGRADED"],"type":"string","description":"Status of the container application.","title":"Status of the container application"},"network_status":{"readOnly":false,"enum":["HEALTHY","UNHEALTHY"],"type":"string","description":"Network status of container application.","title":"Network status of container application"},"container_cluster_id":{"readOnly":true,"type":"string","description":"Identifier of the container cluster this container application belongs to.","title":"Identifier of the container cluster"},"origin_properties":{"items":{"$ref":"#/definitions/KeyValuePair"},"readOnly":false,"type":"array","description":"Array of additional specific properties of container application\nin key-value format.\n","title":"Origin properties"},"external_id":{"readOnly":false,"type":"string","description":"Identifier of the container application on container cluster\ne.g. PCF app id, k8s service id.\n","title":"External identifier of the container application"},"container_project_id":{"readOnly":false,"type":"string","description":"Identifier of the project which this container application belongs to.","title":"Identifier of the project"},"network_errors":{"items":{"$ref":"#/definitions/NetworkError"},"readOnly":false,"type":"array","description":"List of network errors related to container application.","title":"Network errors"}}}],"description":"Container application within a project.","title":"Container application within a project"},"DhcpProfile":{"x-vmw-nsx-module":"Dhcp","allOf":[{"$ref":"#/definitions/ManagedResource"},{"required":["edge_cluster_id"],"x-vmw-nsx-module":"Dhcp","type":"object","properties":{"edge_cluster_member_indexes":{"description":"The Edge nodes on which the DHCP servers run. If none is provided, the\nNSX will auto-select two edge-nodes from the given edge cluster. If only\none edge node is provided, the DHCP servers will run without HA support.\n","title":"Edge node indexes","minItems":0,"items":{"type":"integer","format":"int64"},"maxItems":2,"uniqueItems":true,"type":"array"},"enable_standby_relocation":{"default":false,"type":"boolean","description":"Flag to enable the auto-relocation of standby DHCP Service in case\nof edge node failure. Only tier 1 and auto placed DHCP servers are\nconsidered for the relocation.\n","title":"Flag to enable standby DHCP server relocation"},"edge_cluster_id":{"type":"string","description":"Edge cluster uuid on which the referencing logical DHCP server runs.\n","title":"Edge cluster uuid"}}}],"description":"DHCP profile to specify edge cluster and members on which the dhcp server\nwill run. A DhcpProfile can be referenced by different logical DHCP servers.\n","title":"DHCP profile to specify edge cluster and members"},"LbPassiveMonitor":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/LbMonitor"},{"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"max_fails":{"description":"When the consecutive failures reach this value, then the member is\nconsidered temporarily unavailable for a configurable period\n","title":"number of consecutive connection failures","default":5,"format":"int64","maximum":2147483647,"minimum":1,"type":"integer"},"timeout":{"description":"After this timeout period, the member is tried again for a new\nconnection to see if it is available.\n","title":"timeout in seconds before it is selected again for a new connection","default":5,"format":"int64","maximum":2147483647,"minimum":1,"type":"integer"}}}]},"SIPacketsDroppedBySecurity":{"x-vmw-nsx-module":"ServiceInsertionVMDeployment","type":"object","properties":{"spoof_guard_dropped":{"items":{"$ref":"#/definitions/SIPacketTypeAndCounter"},"type":"array","description":"The packets dropped by \"Spoof Guard\"; supported packet types are IPv4, IPv6, ARP, ND, non-IP.","title":"The packets dropped by \"Spoof Guard\"; supported packet types are IPv4, IPv6, ARP, ND, non-IP."},"dhcp_server_dropped_ipv4":{"format":"int64","type":"integer","description":"The number of IPv4 packets dropped by \"DHCP server block\".","title":"The number of IPv4 packets dropped by \"DHCP server block\"."},"dhcp_server_dropped_ipv6":{"format":"int64","type":"integer","description":"The number of IPv6 packets dropped by \"DHCP server block\".","title":"The number of IPv6 packets dropped by \"DHCP server block\"."},"dhcp_client_dropped_ipv4":{"format":"int64","type":"integer","description":"The number of IPv4 packets dropped by \"DHCP client block\".","title":"The number of IPv4 packets dropped by \"DHCP client block\"."},"bpdu_filter_dropped":{"format":"int64","type":"integer","description":"The number of packets dropped by \"BPDU filter\".","title":"The number of packets dropped by \"BPDU filter\"."},"dhcp_client_dropped_ipv6":{"format":"int64","type":"integer","description":"The number of IPv6 packets dropped by \"DHCP client block\".","title":"The number of IPv6 packets dropped by \"DHCP client block\"."}}},"EgressRateShaper":{"x-vmw-nsx-module":"QosSwitchingProfile","allOf":[{"$ref":"#/definitions/QosBaseRateShaper"},{"x-vmw-nsx-module":"QosSwitchingProfile","type":"object","properties":{"average_bandwidth_mbps":{"description":"Average bandwidth in Mb/s","format":"int32","default":0,"title":"Average bandwidth in Mb/s","minimum":0,"type":"integer"},"peak_bandwidth_mbps":{"description":"Peak bandwidth in Mb/s","format":"int32","default":0,"title":"Peak bandwidth in Mb/s","minimum":0,"type":"integer"},"burst_size_bytes":{"description":"Burst size in bytes","format":"int32","default":0,"title":"Burst size in bytes","minimum":0,"type":"integer"}}}],"description":"A shaper that specifies egress rate properties in Mb/s","title":"A shaper that specifies egress rate properties in Mb/s"},"GraphConfiguration":{"x-vmw-nsx-module":"NsxDashboard","allOf":[{"$ref":"#/definitions/WidgetConfiguration"},{"required":["graphs"],"x-vmw-nsx-module":"NsxDashboard","type":"object","properties":{"x_value_type":{"default":"string","enum":["string","number","date","millisecond","second"],"type":"string","description":"x value type.","title":"x value type"},"y_value_type":{"enum":["integer","double"],"type":"string","description":"y value type.","title":"y value type"},"graphs":{"minItems":1,"items":{"$ref":"#/definitions/GraphDefinition"},"type":"array","description":"Graphs","title":"Graphs"},"line_chart_plot_configs":{"items":{"$ref":"#/definitions/LineChartPlotConfiguration"},"type":"array","description":"List of line chart plotting configuration. This plotting configuration will be applicable for the LINE_GRAPH only.","title":"List of line chart plotting configuration"},"axes":{"$ref":"#/definitions/Axes"},"navigation":{"type":"string","description":"Hyperlink of the specified UI page that provides details.","title":"Navigation to a specified UI page"},"sub_type":{"default":"BAR_GRAPH","enum":["LINE_GRAPH","BAR_GRAPH","STACKED_BAR_GRAPH"],"type":"string","description":"Describes the the type of graph. LINE_GRAPH shows a line graph chart BAR_GRAPH shows a simple bar graph chart STACKED_BAR_GRAPH shows a stacked bar graph chart","title":"Subtype of a graph"},"display_x_value":{"default":false,"type":"boolean","description":"If true, value of a point is shown as label on X axis. If false, value of point is not shown as label on X axis. false can be useful in situations where there are too many points and showing the X value as label can clutter the X axis.","title":"Show or hide the value of a point on X axis"},"graphs_colors":{"items":{"type":"string"},"type":"array","description":"An array of graphs colors which will be applied to each graph seperately. if number of provided colors are smaller than number of graph in the widget then colors are applied in circular manner.","title":"A colors for the graph"}}}],"description":"Represents configuration of a graph widget","title":"Graph Configuration"},"LbHttpResponseHeaderDeleteAction":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/LbRuleAction"},{"required":["header_name"],"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"header_name":{"type":"string","description":"Name of a header field of HTTP response message","title":"Name of a header field of HTTP response message"}}}],"description":"This action is used to delete header fields of HTTP response messages at\nHTTP_RESPONSE_REWRITE phase. One action can be used to delete allgi headers\nwith same header name. To delete headers with different header names,\nmultiple actions must be defined\n","title":"Action to delete HTTP response header fields"},"AssignedByDhcp":{"x-vmw-nsx-module":"TransportNode","allOf":[{"$ref":"#/definitions/IpAssignmentSpec"},{"x-vmw-nsx-module":"TransportNode","type":"object"}],"description":"This type can be specified in ip assignment spec of host switch if DHCP based IP assignment is desired for host switch virtual tunnel endpoints.","title":"DHCP based IP assignment."},"VtepLabelPool":{"x-vmw-nsx-module":"VtepLabel","description":"A collection of ranges of virtual tunnel endpoint labels","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"VtepLabel","required":["ranges"],"type":"object","properties":{"ranges":{"items":{"$ref":"#/definitions/VtepLabelRange"},"type":"array","description":"Array of ranges for virtual tunnel endpoint labels","title":"Array of ranges for virtual tunnel endpoint labels"},"pool_usage":{"$ref":"#/definitions/VtepLabelPoolUsage"}}}]},"RelatedApiError":{"x-vmw-nsx-module":"Common","type":"object","description":"Detailed information about a related API error","properties":{"module_name":{"type":"string","description":"The module name where the error occurred","title":"The module name where the error occurred"},"error_message":{"type":"string","description":"A description of the error","title":"A description of the error"},"error_code":{"format":"int64","type":"integer","description":"A numeric error code","title":"A numeric error code"},"details":{"type":"string","description":"Further details about the error","title":"Further details about the error"},"error_data":{"type":"object","description":"Additional data about the error","title":"Additional data about the error"}},"title":"Detailed information about a related API error"},"AxisUnit":{"x-vmw-nsx-module":"NsxDashboard","type":"object","description":"Represents X and Y axis unit of a graph.","properties":{"condition":{"maxLength":1024,"type":"string","description":"If the condition is met then the above unit will be displayed. to UI. If no condition is provided, then the unit will be displayed unconditionally.","title":"Expression for evaluating condition"},"unit":{"enum":["COUNT","PERCENT","BYTES","MILLISECONDS","SECONDS","MINUTE","HOUR","DAY","KILO_BYTES","MEGA_BYTES","GIGA_BYTES"],"type":"string","description":"An Axis unit.","title":"An Axis unit."}},"title":"Axis unit of a graph"},"DiscoveredNodeNetworkInterfaces":{"description":"All the network interfaces of the discovered node","title":"Discovered node network interfaces","required":["discovered_node_id"],"x-vmw-nsx-module":"InventoryCmObj","type":"object","properties":{"discovered_node_id":{"type":"string","description":"Id of the discovered node","title":"Discovered node Id"},"network_interfaces":{"items":{"$ref":"#/definitions/DiscoveredNodeInterfaceProperties"},"type":"array","description":"Network interfaces of the node","title":"Discovered Node interfaces"}}},"LbServiceListResult":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"LoadBalancer","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/LbService"},"type":"array","description":"paginated list of load balancer services","title":"paginated list of load balancer services"}}}]},"AdvertisementConfig":{"x-vmw-nsx-module":"Routing","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"Routing","type":"object","properties":{"advertise_nsx_connected_routes":{"default":false,"type":"boolean","description":"Flag to advertise all connected routes","title":"Advertise connected routes"},"advertise_lb_vip":{"default":false,"type":"boolean","description":"Flag to advertise lb vip ips","title":"Advertise lb vip ips"},"advertise_static_routes":{"default":false,"type":"boolean","description":"Flag to advertise all static routes","title":"Advertise static routes"},"logical_router_id":{"readOnly":true,"type":"string","description":"TIER1 logical router id on which to enable this configuration","title":"Logical router id"},"advertise_dns_forwarder":{"default":false,"type":"boolean","description":"Flag to advertise all routes of dns forwarder listener ips and source ips","title":"Advertise dns forwarder ips"},"advertise_nat_routes":{"default":false,"type":"boolean","description":"Flag to advertise all routes of nat","title":"Advertise NAT routes"},"advertise_ipsec_local_ip":{"default":false,"type":"boolean","description":"Flag to advertise all IPSec VPN local endpoint ips to linked TIER0 logical router","title":"Advertise IPSec VPN local endpoint ips"},"enabled":{"default":false,"type":"boolean","description":"Flag to enable this configuration","title":"Enable advertisement"},"advertise_lb_snat_ip":{"default":false,"type":"boolean","description":"Flag to advertise all lb SNAT ips","title":"Advertise lb SNAT ips"}}}],"description":"Advertisement config for different types of\nroutes which need to be advertised from TIER1 logical\nrouter to the linked TIER0 logical router\n","title":"Advertisement config"},"FipsGlobalConfig":{"x-vmw-nsx-module":"GlobalConfigs","allOf":[{"$ref":"#/definitions/GlobalConfigs"},{"x-vmw-nsx-module":"GlobalConfigs","type":"object","properties":{"lb_fips_enabled":{"default":false,"type":"boolean","description":"When this flag is set to true FIPS mode will be set on ssl encryptions of load balancer feature.","title":"A flag to turn on or turn off the FIPS compliance of load balancer feature."}}}],"description":"Policy api will overwrite the fipsGlobalConfig set using MP api. Always use https://<policyIp>/policy/api/v1/infra/global-config to update fips configuration.","title":"NSX global configs for FIPS compliance settings"},"DirectoryOrgUnit":{"description":"Organization Unit","title":"Organization Unit","required":["distinguished_name","name","children"],"x-vmw-nsx-module":"DirectoryService","type":"object","properties":{"distinguished_name":{"type":"string","description":"Distinguished name of the organization unit.","title":"Distinguished name"},"name":{"type":"string","description":"Organization Unit name.","title":"Organization Unit name"},"children":{"items":{"$ref":"#/definitions/DirectoryOrgUnit"},"type":"array","description":"List of children Organization Units if any.\n","maxItems":500,"title":"List of children Organization Units"}}},"PolicyTraceflowObservationDropped":{"x-vmw-nsx-module":"PolicyConnectivity","allOf":[{"$ref":"#/definitions/TraceflowObservationDropped"},{"x-vmw-nsx-module":"PolicyConnectivity","type":"object","properties":{"acl_rule_path":{"readOnly":true,"type":"string","description":"The path of the ACL rule that was applied to forward the traceflow packet","title":"Access Control List Rule Path"},"nat_rule_path":{"readOnly":true,"type":"string","description":"The path of the NAT rule that was applied to forward the traceflow packet","title":"Network Address Translation Rule Path"},"segment_port_path":{"readOnly":true,"type":"string","description":"The path of the segment port or router port at which the traceflow packet was dropped","title":"The path of the segment port or router port at which the traceflow packet was dropped"}}}]},"NvdsUpgradeStatusSummary":{"x-vmw-nsx-module":"NvdsUpgradeReadinessCheck","type":"object","description":"Overall status of the upgrade readiness check","properties":{"precheck_id":{"readOnly":true,"type":"string","description":"Tracking ID of nvds upgrade precheck","title":"Tracking ID of nvds upgrade precheck"},"migration_state":{"items":{"$ref":"#/definitions/NvdsUpgradeHostState"},"readOnly":true,"type":"array","description":"Overall state of migration across all TransportNodes","title":"Overall state of migration across all TransportNodes"},"precheck_issue":{"items":{"$ref":"#/definitions/NvdsUpgradeConfigIssue"},"readOnly":true,"type":"array","description":"Config issue in pre-check","title":"Config issue in pre-check"},"precheck_status":{"readOnly":true,"enum":["IN_PROGRESS","FAILED","PENDING_TOPOLOGY","APPLYING_TOPOLOGY","APPLY_TOPOLOGY_FAILED","READY"],"type":"string","description":"Overall status of pre-check","title":"Overall status of pre-check"}},"title":"Overall status of the upgrade readiness check"},"LogicalPortMacAddressListResult":{"x-vmw-nsx-module":"AggSvcLogicalPort","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"AggSvcLogicalPort","type":"object","properties":{"logical_port_id":{"readOnly":true,"type":"string","description":"The id of the logical port","title":"The id of the logical port"},"last_update_timestamp":{"description":"Timestamp when the data was last updated; unset if data source has never updated the data.","format":"int64","readOnly":true,"type":"integer"},"results":{"items":{"$ref":"#/definitions/LogicalPortMacTableEntry"},"type":"array"},"transport_node_id":{"readOnly":true,"type":"string","description":"Transport node identifier","title":"Transport node identifier"}}}]},"IntelligenceClusterNodeVMDeploymentRequestList":{"x-vmw-nsx-module":"NsxIntelligenceDeployment","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"NsxIntelligenceDeployment","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/IntelligenceClusterNodeVMDeploymentRequest"},"type":"array","description":"Array of existing IntelligenceClusterNodeVMDeploymentRequests\n","title":"Results"}}}],"description":"List of IntelligenceClusterNodeVMDeploymentRequests","title":"IntelligenceClusterNodeVMDeploymentRequest list"},"IPSecVPNIKEServiceSummary":{"x-vmw-nsx-module":"VPNStatistics","allOf":[{"$ref":"#/definitions/IPSecVPNSessionSummary"},{"x-vmw-nsx-module":"VPNStatistics","type":"object","properties":{"ipsec_vpn_service_id":{"readOnly":true,"type":"string","description":"UUID for a vpn service.","title":"Service identifier"},"display_name":{"readOnly":true,"type":"string","description":"VPN service display name.","title":"Display name"},"logical_router_id":{"readOnly":true,"type":"string","description":"Logical router identifier associated with vpn service.","title":"Logical router identifier"}}}],"description":"Summarized view of all IPSec VPN sessions for a specified service.","title":"IPSec VPN IKE service summary"},"LogicalSwitchState":{"x-vmw-nsx-module":"LogicalSwitch","allOf":[{"$ref":"#/definitions/ConfigurationState"},{"x-vmw-nsx-module":"LogicalSwitch","type":"object","properties":{"logical_switch_id":{"readOnly":true,"type":"string","description":"Id of the logical switch","title":"Id of the logical switch"}}}]},"LbPoolListResult":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"LoadBalancer","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/LbPool"},"type":"array","description":"paginated list of pools","title":"paginated list of pools"}}}]},"HostNodeLoginCredential":{"x-vmw-nsx-module":"FabricNode","type":"object","description":"The credentials to login into the host node","properties":{"username":{"type":"string","description":"The username of the account on the host node","title":"The username of the account on the host node"},"password":{"type":"string","description":"The authentication password of the host node","title":"The authentication password of the host node"},"thumbprint":{"type":"string","description":"For ESXi hosts, the thumbprint of the ESXi management service.\nFor KVM hosts, the SSH key fingerprint.\nIf thumbprint is not provided then connection to host may not\nbe established and API call will fail.\n","title":"ESXi thumbprint or SSH key fingerprint of the host node"}},"title":"The credentials to login into the host node"},"HostNodeStatus":{"x-vmw-nsx-module":"ComputeCollectionDeployment","type":"object","description":"Host Node Status","properties":{"config_status":{"readOnly":true,"enum":["pending","in_progress","success","failed","partial_success","orphaned","unknown","error"],"type":"string","description":"Gives details of state of desired configuration. This property is available only if Tranport Node exists for the host. Following are the supported values pending - Transport Node configuration status is pending in_progress - Transport Node configuration status is in progress success - Transport Node configuration status is successful failed - Transport Node configuration status is failed partial_success - Transport Node configuration status is partial success orphaned - Transport Node configuration status is orphaned unknown - Transport Node configuration status is unknown error - Error occured during Transport Node configuration","title":"Configuration status of host node"},"node_id":{"readOnly":true,"type":"string","description":"Unique Id of the host node","title":"Unique Id of the host node"},"deployment_status":{"readOnly":true,"enum":["INSTALL_IN_PROGRESS","INSTALL_FAILED","INSTALL_SUCCESSFUL","UNINSTALL_IN_PROGRESS","UNINSTALL_FAILED","UNINSTALL_SUCCESSFUL","UNINSTALL_SCHEDULED","UPGRADE_IN_PROGRESS","UPGRADE_FAILED","DEPLOYMENT_QUEUED","DEPLOYMENT_IN_PROGRESS","DEPLOYMENT_FAILED","DEPLOYMENT_SUCCESSFUL","UNDEPLOYMENT_QUEUED","UNDEPLOYMENT_IN_PROGRESS","UNDEPLOYMENT_FAILED","UNDEPLOYMENT_SUCCESSFUL","UPGRADE_QUEUED","HOST_DISCONNECTED","POWERED_OFF"],"type":"string","description":"This specifies the current nsx install status for host node. Following are the supported values INSTALL_IN_PROGRESS - NSX installation is in progress on the host INSTALL_FAILED - NSX installation failed on the host INSTALL_SUCCESSFUL - NSX installation successful on the host UNINSTALL_IN_PROGRESS - NSX uninstallation in progress on the host UNINSTALL_FAILED - NSX uninstallation failed on the host UNINSTALL_SUCCESSFUL - NSX uninstallation successful on the host UNINSTALL_SCHEDULED - NSX uninstallation is scheduled on the host UPGRADE_IN_PROGRESS - NSX upgrade is in progress on the host UPGRADE_FAILED - NSX upgrade failed on the host DEPLOYMENT_QUEUED - Deployment is queued on the DEPLOYMENT_IN_PROGRESS - Deployment is in progress DEPLOYMENT_FAILED - Deployment is failed DEPLOYMENT_SUCCESSFUL - Deployment is successful UNDEPLOYMENT_QUEUED - Undeployment is queued UNDEPLOYMENT_IN_PROGRESS - Undeployment is in progress UNDEPLOYMENT_FAILED - Undeployment failed UNDEPLOYMENT_SUCCESSFUL - Undeployment is successful UPGRADE_QUEUED - Upgrade is queued HOST_DISCONNECTED - Host is disconnected POWERED_OFF - Host is powered off","title":"Deployment progress status of host node"}},"title":"Host Node Status"},"LogicalRouterIPTunnelPort":{"x-vmw-nsx-module":"LogicalRouterPorts","allOf":[{"$ref":"#/definitions/LogicalRouterPort"},{"x-vmw-nsx-module":"LogicalRouterPorts","type":"object","properties":{"subnets":{"description":"Tunnel port subnets.","title":"Tunnel port subnets","minItems":1,"items":{"$ref":"#/definitions/IPSubnet"},"readOnly":true,"maxItems":1,"type":"array"},"admin_state":{"readOnly":true,"enum":["UP","DOWN"],"type":"string","description":"Admin state of port.","title":"Admin state of port"},"vpn_session_id":{"readOnly":true,"type":"string","description":"Associated VPN session identifier.","title":"VPN session identifier"}}}],"description":"Logical router IP tunnel port.","title":"Logical router IP tunnel port"},"ResourceAllocation":{"description":"Specify limit, shares and reservation for all kinds of traffic.\nValues for limit and reservation are expressed in percentage. And for shares,\nthe value is expressed as a number between 1-100.\nThe overall reservation among all traffic types should not exceed 75%.\nOtherwise, the API request will be rejected.\n","title":"Resource allocation information for a host infrastructure traffic type","required":["reservation","traffic_type","limit","shares"],"x-vmw-nsx-module":"NiocProfile","type":"object","properties":{"reservation":{"description":"Minimum guaranteed bandwidth percentage","title":"Minimum guaranteed bandwidth percentage","default":0.0,"maximum":75,"minimum":0,"type":"number"},"traffic_type":{"$ref":"#/definitions/HostInfraTrafficType"},"limit":{"description":"The limit property specifies the maximum bandwidth allocation for a given\ntraffic type and is expressed in percentage. The default value for this\nfield is set to -1 which means the traffic is unbounded for the traffic\ntype. All other negative values for this property is not supported\nand will be rejected by the API.\n","title":"Maximum bandwidth percentage","default":-1.0,"maximum":100,"minimum":-1,"type":"number"},"shares":{"description":"Shares","title":"Shares","default":50,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}},"ErrorResolverUserInputData":{"x-vmw-nsx-module":"ErrorResolver","required":["data_type","property_name"],"type":"object","description":"Corresponds to one property entered by the user","properties":{"data_type":{"enum":["TEXT","NUMBER","PASSWORD"],"type":"string","description":"The datatype of the given property. Useful for data validation","title":"The datatype of the given property. Useful for data validation"},"property_name":{"type":"string","description":"Name of the property supplied by the user","title":"Name of the property supplied by the user"},"property_value":{"type":"string","description":"The value associated with the above property","title":"The value associated with the above property"}}},"PacketNumberSampling":{"x-vmw-nsx-module":"LiveTrace","allOf":[{"$ref":"#/definitions/SamplingArgument"},{"x-vmw-nsx-module":"LiveTrace","required":["sampling_rate"],"type":"object","properties":{"sampling_rate":{"description":"1 out of how many packets is sampled","format":"int64","title":"1 out of how many packets is sampled","maximum":65535,"minimum":1,"type":"integer"}}}]},"SourceEntity":{"x-vmw-nsx-module":"ServiceInsertionCommonTypes","type":"object","description":"Service insertion data path inserts unique 'source node id' value into each packet before it received by Service VM. This value can be resolved to multiple Source Entities. It represents source of the packets.","properties":{"source_entity_type":{"readOnly":true,"enum":["VIRTUAL_NETWORK_INTERFACE","VIRTUAL_MACHINE"],"type":"string","description":"Type of source entity. Currently source value can be resolved to VIF and Virtual Machine.","title":"Source entity type"},"source_entity_id":{"readOnly":true,"type":"string","description":"UUID of Source entity","title":"Source entity ID"}},"title":"Source entity"},"BgpAddressFamily":{"x-vmw-nsx-module":"AggSvcLogicalRouter","type":"object","properties":{"out_prefix_count":{"readOnly":true,"format":"int64","type":"integer","description":"Count of out prefixes","title":"Count of out prefixes"},"type":{"readOnly":true,"enum":["IPV4_UNICAST","VPNV4_UNICAST","IPV6_UNICAST","L2VPN_EVPN"],"type":"string","description":"BGP address family type","title":"BGP address family type"},"in_prefix_count":{"readOnly":true,"format":"int64","type":"integer","description":"Count of in prefixes","title":"Count of in prefixes"}}},"PendingChange":{"x-vmw-nsx-module":"Firewall","type":"object","properties":{"request_id":{"type":"string","description":"Request identifier of the API which modified the entity.","title":"Request_id of the API change"}}},"L2VpnSession":{"x-vmw-nsx-module":"L2VPN","allOf":[{"$ref":"#/definitions/ManagedResource"},{"required":["transport_tunnels","l2vpn_service_id"],"x-vmw-nsx-module":"L2VPN","type":"object","properties":{"transport_tunnels":{"description":"List of transport tunnels for redundancy.","title":"List of transport tunnels","minItems":1,"items":{"$ref":"#/definitions/ResourceReference"},"maxItems":1,"type":"array"},"tunnel_encapsulation":{"$ref":"#/definitions/L2VpnTunnelEncapsulation"},"enabled":{"default":true,"type":"boolean","description":"Enable to extend all the associated logical switches.","title":"Enable L2VPN session"},"l2vpn_tcp_mss_clamping":{"$ref":"#/definitions/L2VpnTcpMssClamping"},"l2vpn_service_id":{"type":"string","description":"L2VPN service id","title":"L2VPN service id"}}}],"description":"Defines the tunnel local and peer addresses along with the multiple tansport tunnels for redundancy. L2VpnSession belongs on to only one L2VpnService.","title":"L2VPN Session"},"EdgeMemberAllocationStatus":{"x-vmw-nsx-module":"EdgeClusters","type":"object","properties":{"allocated_services":{"items":{"$ref":"#/definitions/AllocatedService"},"readOnly":true,"type":"array","description":"List of services allocated on the edge node.","title":"Services allocated on edge node"},"node_display_name":{"readOnly":true,"type":"string","description":"Display name of edge cluster member. Defaults to ID if not set.\n","title":"Identifier to use when displaying cluster member in logs or GUI"},"member_index":{"readOnly":true,"format":"int32","type":"integer","description":"System generated index for transport node backed by edge node.\n","title":"System generated index for cluster member"},"allocation_pools":{"items":{"$ref":"#/definitions/AllocationPool"},"readOnly":true,"type":"array","description":"Allocation details of pools defined on the edge node.","title":"Pool Allocation details"},"node_id":{"readOnly":true,"type":"string","description":"System allotted UUID of edge node.","title":"Unique identifier of edge node"}}},"IdfwEnabledComputeCollectionListResult":{"x-vmw-nsx-module":"IdentityFirewall","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"IdentityFirewall","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/IdfwEnabledComputeCollection"},"type":"array","description":"Array of IDFW Enabled Compute Collections.","title":"List of IDFW Enabled Compute Collections"}}}],"description":"List of compute collections enabled for IDFW where login events will be\ncollected.\n","title":"Identity Firewall enabled compute collection list"},"VmNicInfo":{"description":"Contains a set of information of a VM on the network interfaces present on the partner appliance that needs to be configured by the NSX Manager.","title":"Set of NIC information of a VM","required":["nic_infos"],"x-vmw-nsx-module":"ServiceInsertionCommonTypes","type":"object","properties":{"nic_infos":{"items":{"$ref":"#/definitions/NicInfo"},"readOnly":false,"type":"array","description":"Set of information of a VM on the network interfaces present on the partner appliance that needs to be configured by the NSX Manager.","title":"Set of NIC information of a VM"}}},"LbMonitorListResult":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"LoadBalancer","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/LbMonitor"},"type":"array","description":"paginated list of load balancer monitors","title":"paginated list of load balancer monitors"}}}]},"IPMirrorDestination":{"x-vmw-nsx-module":"PortMirroring","allOf":[{"$ref":"#/definitions/MirrorDestination"},{"x-vmw-nsx-module":"PortMirroring","required":["destination_ips","encapsulation_type"],"type":"object","properties":{"destination_ips":{"description":"The destination IPs of the mirror packet will be sent to.","title":"List of destination IP addresses","minItems":1,"items":{"description":"IPv4 or IPv6 address","format":"ip","type":"string"},"maxItems":3,"type":"array"},"encapsulation_type":{"description":"You can choose GRE, ERSPAN II or ERSPAN III.","default":"GRE","enum":["GRE","ERSPAN_TWO","ERSPAN_THREE"],"type":"string"},"erspan_id":{"description":"Used by physical switch for the mirror traffic forwarding.\nMust be provided and only effective when encapsulation type is\nERSPAN type II or type III.\n","format":"int32","title":"ERSPAN session id","maximum":1023,"minimum":0,"type":"integer"},"gre_key":{"format":"int32","type":"integer","description":"User-configurable 32-bit key only for GRE","title":"GRE encapsulation key"}}}]},"MigrationStatus":{"x-vmw-nsx-module":"Migration","type":"object","properties":{"overall_migration_status":{"readOnly":true,"enum":["SUCCESS","FAILED","IN_PROGRESS","NOT_STARTED","PAUSING","PAUSED"],"type":"string","description":"Status of migration","title":"Status of migration"},"component_status":{"items":{"$ref":"#/definitions/ComponentMigrationStatus"},"readOnly":true,"type":"array","description":"List of component statuses","title":"List of component statuses"}}},"LbPoolMemberStatus":{"x-vmw-nsx-module":"AggSvcLb","required":["status","ip_address"],"type":"object","properties":{"status":{"enum":["UP","DOWN","DISABLED","GRACEFUL_DISABLED","UNUSED","UNKNOWN"],"type":"string","description":"UP means that pool member is enabled and monitors have marked the pool\nmember as UP. If the pool member has no monitor configured, it would\nbe treated as UP.\nDOWN means that pool member is enabled and monitors have marked the\npool member as DOWN.\nDISABLED means that admin state of pool member is set to DISABLED.\nGRACEFUL_DISABLED means that admin state of pool member is set to\nGRACEFUL_DISABLED.\nUNUSED means that the pool member is not used when the IP list size\nof member group exceeds the maximum setting. The remaining IP addresses\nwould not be used as available backend servers, hence mark the status\nas UNUSED.\nUNKNOWN means that the related pool is not associated to any enabled\nvirtual servers, or no status reported from transport-nodes, the\nassociated load balancer service may be working(or not working).\n","title":"Pool member status"},"failure_cause":{"type":"string","description":"If multiple active monitors are configured, the failure_cause contains\nfailure cause for each monitors. Like \"Monitor_1:failure_cause_1.\nMonitor_2:failure_cause_2.\"\n","title":"The healthcheck failure cause when status is DOWN"},"last_check_time":{"type":"integer","description":"If multiple active monitors are configured, the property value is the\nlatest last_check_time among all the monitors.\n","format":"int64"},"ip_address":{"description":"Pool member IP address","format":"ip","type":"string"},"last_state_change_time":{"type":"integer","description":"If multiple active monitors are configured, the property value is the\nlatest last_state_change_time among all the monitors.\n","format":"int64"},"port":{"description":"The port is configured in pool member. For virtual server port range\ncase, pool member port must be null.\n","format":"port-or-range","type":"string"}}},"MacLearningCounters":{"x-vmw-nsx-module":"AggSvcL2Types","type":"object","properties":{"macs_learned":{"format":"int64","type":"integer","description":"Number of MACs learned","title":"Number of MACs learned"},"mac_not_learned_packets_dropped":{"format":"int64","type":"integer","description":"The number of packets with unknown source MAC address that are dropped without learning the source MAC address. Applicable only when the MAC limit is reached and MAC Limit policy is MAC_LEARNING_LIMIT_POLICY_DROP.","title":"Number of dropped packets with unknown source MAC address."},"mac_not_learned_packets_allowed":{"format":"int64","type":"integer","description":"The number of packets with unknown source MAC address that are dispatched without learning the source MAC address. Applicable only when the MAC limit is reached and MAC Limit policy is MAC_LEARNING_LIMIT_POLICY_ALLOW.","title":"Number of dispatched packets with unknown source MAC address."}}},"EULAAcceptance":{"x-vmw-nsx-module":"EULA","allOf":[{"$ref":"#/definitions/ManagedResource"},{"required":["acceptance"],"x-vmw-nsx-module":"EULA","type":"object","properties":{"acceptance":{"type":"boolean","description":"Acceptance status of End User License Agreement","title":"End User License Agreement acceptance status"}}}],"description":"Indicate the status of End User License Agreement acceptance","title":"EULA acceptance status"},"DirectoryDomainSize":{"x-vmw-nsx-module":"DirectoryService","type":"object","description":"Size of Directory Domain","properties":{"group_count":{"readOnly":true,"format":"int32","type":"integer","description":"Number of groups","title":"Number of groups"},"user_count":{"readOnly":true,"format":"int32","type":"integer","description":"Number of users","title":"Number of users"},"group_member_count":{"readOnly":true,"format":"int32","type":"integer","description":"Number of group members","title":"Number of group members"}},"title":"Size of Directory Domain"},"L2ForwarderRemoteMacsPerSite":{"x-vmw-nsx-module":"AggSvcL2Forwarder","type":"object","properties":{"remote_standby_ips":{"items":{"description":"IPv4 or IPv6 address","format":"ip","type":"string"},"readOnly":true,"type":"array","description":"Remote standby IP addresses.","title":"Remote standby IPs"},"rtep_group_id":{"readOnly":true,"format":"int64","type":"integer","description":"32 bit unique RTEP group id of the logical switch per site.\n","title":"RTEP group id of logical switch per site"},"remote_site":{"$ref":"#/definitions/ResourceReference"},"remote_active_ips":{"items":{"description":"IPv4 or IPv6 address","format":"ip","type":"string"},"readOnly":true,"type":"array","description":"Remote active IP addresses.","title":"Remote active IPs"},"remote_mac_addresses":{"items":{"type":"string"},"readOnly":true,"type":"array","description":"Remote mac addresses.","title":"Remote mac addresses"}}},"NodeIdServicesMap":{"x-vmw-nsx-module":"CertificateManager","required":["service_types","node_id"],"type":"object","properties":{"service_types":{"items":{"description":"Supported service types, that are using certificates.","enum":["MGMT_CLUSTER","MGMT_PLANE","API","NOTIFICATION_COLLECTOR","SYSLOG_SERVER","RSYSLOG_CLIENT","APH","GLOBAL_MANAGER","LOCAL_MANAGER","CLIENT_AUTH","RMQ","K8S_MSG_CLIENT"],"type":"string"},"readOnly":false,"type":"array","description":"List of ServiceTypes."},"node_id":{"readOnly":false,"maxLength":255,"type":"string","description":"NodeId","title":"NodeId"}}},"PreconfiguredHostSwitchSpec":{"x-vmw-nsx-module":"TransportNode","allOf":[{"$ref":"#/definitions/HostSwitchSpec"},{"required":["host_switches"],"x-vmw-nsx-module":"TransportNode","type":"object","properties":{"host_switches":{"items":{"$ref":"#/definitions/PreconfiguredHostSwitch"},"type":"array","description":"Preconfigured Transport Node host switches","maxItems":1,"title":"Preconfigured Transport Node host switches"}}}],"description":"Preconfigured host switch specification is used for manually configured transport node. It is user's responsibility to ensure correct configuration is provided to NSX. This type is only valid for supported KVM fabric nodes.","title":"Specification of transport node preconfigured host switch"},"ErrorResolverInfoList":{"description":"Collection of all registered ErrorResolverInfo","title":"Collection of all registered ErrorResolverInfo","required":["results"],"x-vmw-nsx-module":"ErrorResolver","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/ErrorResolverInfo"},"type":"array","description":"ErrorResolverInfo list","title":"ErrorResolverInfo list"}}},"SamplingArgument":{"discriminator":"sampling_type","x-vmw-nsx-module":"LiveTrace","required":["sampling_type"],"type":"object","properties":{"sampling_type":{"enum":["FirstNSampling","PacketNumberSampling","IntervalSampling"],"type":"string","description":"Sampling type","title":"Sampling type"}}},"IPSecVPNServiceListResult":{"x-vmw-nsx-module":"IPSecVPN","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"IPSecVPN","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/IPSecVPNService"},"type":"array","description":"IPSec VPN serivce list result","title":"IPSec VPN serivce list result"}}}],"description":"List all the IPSec VPN services.","title":"List IPSec VPN services"},"FederationStatus":{"x-vmw-nsx-module":"SiteManagerModule","required":["active_standby_sync_statuses"],"type":"object","properties":{"remote_connections":{"items":{"$ref":"#/definitions/SiteStatus"},"type":"array","description":"Site connection status","title":"Site connection status"},"active_standby_sync_statuses":{"items":{"$ref":"#/definitions/ActiveStandbySyncStatus"},"type":"array","description":"Status of synchronization between active and standby sites.","title":"Status of synchronization between active and standby sites."}}},"PortMirroringSessionListResult":{"x-vmw-nsx-module":"PortMirroring","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"PortMirroring","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/PortMirroringSession"},"readOnly":true,"type":"array","description":"Port mirroring session results","title":"Port mirroring session results"}}}],"description":"Mirror session queries result","title":"Mirror session queries result"},"TraceflowObservationForwardedLogical":{"x-vmw-nsx-module":"Traceflow","allOf":[{"$ref":"#/definitions/TraceflowObservation"},{"x-vmw-nsx-module":"Traceflow","type":"object","properties":{"dst_component_id":{"readOnly":true,"type":"string","description":"The id of the destination component to which the traceflow packet was forwarded.","title":"The id of the destination component to which the traceflow packet was forwarded."},"vlan":{"description":"This field is specified when the traceflow packet was forwarded by a VLAN\nlogical network.\n","format":"int64","readOnly":true,"type":"integer"},"vni":{"readOnly":true,"format":"int32","type":"integer","description":"This field is specified when the traceflow packet was forwarded by an overlay\nlogical network.\n","title":"VNI for the logical network on which the traceflow packet was forwarded."},"l2_rule_id":{"readOnly":true,"format":"int64","type":"integer","description":"This field is specified when the traceflow packet matched a l2 rule.\n","title":"The ID of the l2 rule that was applied to the traceflow packet"},"translated_src_ip":{"description":"The translated source IP address of VPN/NAT","format":"ip","readOnly":true,"type":"string"},"translated_dst_ip":{"description":"The translated destination IP address of VNP/NAT","format":"ip","readOnly":true,"type":"string"},"spoofguard_mac":{"description":"The source MAC address of form:\n\"^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$\". For example: 00:00:00:00:00:00.\n","format":"mac-address","readOnly":true,"type":"string"},"resend_type":{"readOnly":true,"enum":["UNKNOWN","ARP_UNKNOWN_FROM_CP","ND_NS_UNKNWON_FROM_CP"],"type":"string","description":"ARP_UNKNOWN_FROM_CP - Unknown ARP query result emitted by control plane ND_NS_UNKNOWN_FROM_CP - Unknown neighbor solicitation query result emitted by control plane UNKNOWN - Unknown resend type","title":"The type of packet resending"},"spoofguard_ip":{"description":"This field specified the prefix IP address a traceflow packet matched in the whitelist in spoofguard.","format":"ip-cidr-block","readOnly":true,"type":"string"},"jumpto_rule_id":{"readOnly":true,"format":"int64","type":"integer","description":"This field is specified when the traceflow packet matched a jump-to rule.\n","title":"The ID of the jump-to rule that was applied to the traceflow packet"},"service_path_index":{"readOnly":true,"format":"int64","type":"integer","description":"The path index of the service insertion component","title":"The path index of the service insertion component"},"component_id":{"readOnly":true,"type":"string","description":"The id of the component that forwarded the traceflow packet.","title":"The id of the component that forwarded the traceflow packet."},"spoofguard_vlan_id":{"description":"This field specified the VLAN id a traceflow packet matched in the whitelist in spoofguard.","format":"int64","readOnly":true,"type":"integer"},"lport_name":{"readOnly":true,"type":"string","description":"The name of the logical port through which the traceflow packet was forwarded.","title":"The name of the logical port through which the traceflow packet was forwarded."},"acl_rule_id":{"readOnly":true,"format":"int64","type":"integer","description":"This field is specified when the traceflow packet matched a L3 firewall rule.\n","title":"The id of the L3 firewall rule that was applied to forward the traceflow packet"},"service_index":{"readOnly":true,"format":"int64","type":"integer","description":"The index of the service insertion component","title":"The index of the service insertion component"},"dst_component_type":{"description":"The type of the destination component to which the traceflow packet was forwarded.","enum":["PHYSICAL","LR","LS","DFW","BRIDGE","EDGE_TUNNEL","EDGE_HOSTSWITCH","FW_BRIDGE","EDGE_RTEP_TUNNEL","LOAD_BALANCER","NAT","IPSEC","SERVICE_INSERTION","VMC","SPOOFGUARD","EDGE_FW","DLB","ANTREA_SPOOFGUARD","ANTREA_LB","ANTREA_ROUTING","ANTREA_DFW","ANTREA_FORWARDING","HOST_SWITCH","UNKNOWN"],"readOnly":true,"type":"string"},"dst_component_name":{"readOnly":true,"type":"string","description":"The name of the destination component to which the traceflow packet was forwarded.","title":"The name of the destination component to which the traceflow packet was forwarded."},"nat_rule_id":{"readOnly":true,"format":"int64","type":"integer","description":"This field is specified when the traceflow packet matched a NAT rule.\n","title":"The ID of the NAT rule that was applied to forward the traceflow packet"},"lport_id":{"readOnly":true,"type":"string","description":"The id of the logical port through which the traceflow packet was forwarded.","title":"The id of the logical port through which the traceflow packet was forwarded."},"svc_nh_mac":{"readOnly":true,"type":"string","description":"MAC address of nexthop for service insertion(SI)\nin service VM(SVM) where the traceflow packet was received.\n","title":"MAC address of nexthop"},"service_ttl":{"readOnly":true,"format":"int64","type":"integer","description":"The ttl of the service insertion component","title":"The ttl of the service insertion component"}}}]},"LacpGroupConfigInfo":{"x-vmw-nsx-module":"InventoryCmInvComm","type":"object","properties":{"key":{"readOnly":false,"type":"string","description":"The key represents the identifier for the group that is unique\nacross VC.\n","title":"The generated key as the identifier for the group"},"name":{"readOnly":false,"type":"string","description":"The display name of the LACP group.","title":"The display name"},"uplink_port_keys":{"items":{"type":"string"},"readOnly":false,"type":"array","description":"Keys for the uplink ports in the group. Each uplink port is\nassigned a key that is unique across VC.\n","title":"Keys for the uplink ports"},"timeout_type":{"description":"To set the lag mode as fast for LACP. By default, it will be slow.","title":"LACP timeout mode","default":"SLOW","enum":["FAST","SLOW"],"readOnly":false,"type":"string"},"load_balance_algorithm":{"readOnly":false,"type":"string","description":"Load balance algorithm used in LACP group. The possible values\nare dictated by the values available in VC. Please refer\nVMwareDvsLacpLoadBalanceAlgorithm documentation for a full list\nof values. A few examples are srcDestIp where source and destination\nIP are considered, srcIp where only source IP is considered.\n","title":"Load balance policy"},"uplink_num":{"readOnly":false,"format":"int64","type":"integer","description":"The number of uplink ports","title":"The number of uplink ports"},"uplink_names":{"items":{"type":"string"},"readOnly":false,"type":"array","description":"Names for the uplink ports in the group.","title":"Uplink names"},"mode":{"readOnly":false,"enum":["ACTIVE","PASSIVE"],"type":"string","description":"The mode of LACP can be ACTIVE or PASSIVE. If the mode is ACTIVE, LACP\nis enabled unconditionally. If the mode is PASSIVE, LACP is enabled\nonly if LACP device is detected.\n","title":"The mode of Link Aggregation Control Protocol (LACP)"}}},"DhcpStaticBindingListResult":{"x-vmw-nsx-module":"Dhcp","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"Dhcp","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/DhcpStaticBinding"},"type":"array","description":"A paginated list of DHCP static bindings.","title":"Paginated list of DHCP static bindings"}}}],"description":"A paginated list of DHCP static bindings.","title":"A list of DHCP static bindings"},"NodeInstallUpgradeServiceProperties":{"x-vmw-nsx-module":"MISSING_MODULE","allOf":[{"$ref":"#/definitions/NodeServiceProperties"},{"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"service_properties":{"$ref":"#/definitions/InstallUpgradeServiceProperties"}}}],"description":"Node install-upgrade service properties","title":"Node install-upgrade service properties"},"ServiceInsertionStatus":{"x-vmw-nsx-module":"ServiceInsertionStatus","allOf":[{"$ref":"#/definitions/ManagedResource"},{"required":["global_status","context"],"x-vmw-nsx-module":"ServiceInsertionStatus","type":"object","properties":{"global_status":{"description":"service insertion status for a context type (e.g. east_west traffic).","enum":["DISABLED","ENABLED"],"readOnly":false,"type":"string"},"context":{"description":"Type of service insertion contexts.","enum":["east_west","north_south"],"readOnly":false,"type":"string"}}}],"description":"It represents global status of Service Insertion for a particular context type. It shows whether a service insertion is enabled or not for a type.","title":"Service Insertion Status"},"ServiceDefinition":{"x-vmw-nsx-module":"ServiceInsertionCommonTypes","allOf":[{"$ref":"#/definitions/ManagedResource"},{"required":["vendor_id","implementations","functionalities"],"x-vmw-nsx-module":"ServiceInsertionCommonTypes","type":"object","properties":{"service_deployment_spec":{"$ref":"#/definitions/ServiceDeploymentSpec"},"service_capability":{"$ref":"#/definitions/ServiceCapability"},"functionalities":{"description":"The capabilities provided by the services. Needs to be one or more of the following | NG_FW - Next Generation Firewall | IDS_IPS - Intrusion Detection System / Intrusion Prevention System | NET_MON - Network Monitoring | HCX - Hybrid Cloud Exchange | BYOD - Bring Your Own Device | TLB - Transparent Load Balancer | EPP - Endpoint Protection.(Third party AntiVirus partners using NXGI should use this functionality for the service) | MPS - Malware Prevention Solution","title":"Functionality Type","minItems":1,"items":{"enum":["NG_FW","IDS_IPS","NET_MON","HCX","BYOD","EPP","TLB","MPS"],"type":"string"},"readOnly":false,"type":"array"},"attachment_point":{"description":"The point at which the service is deployed/attached for redirecting the traffic to the the partner appliance. Attachment Point is required if Service caters to any functionality other than EPP and MPS.","title":"Attachment Point","minItems":0,"items":{"enum":["TIER0_LR","TIER1_LR","SERVICE_PLANE"],"type":"string"},"readOnly":false,"maxItems":2,"type":"array"},"service_manager_id":{"readOnly":true,"type":"string","description":"ID of the service manager to which this service is attached with.\nThis field is not set during creation of service. This field will\nbe set explicitly when Service Manager is created successfully using this service.\n","title":"Service Manager Id"},"vendor_id":{"readOnly":false,"type":"string","description":"Id which is unique to a vendor or partner for which the service is created.","title":"Vendor ID"},"on_failure_policy":{"description":"Failure policy for the service tells datapath, the action to take i.e to Allow or Block traffic during failure scenarios. For north-south ServiceInsertion, failure policy in the service instance takes precedence. For east-west ServiceInsertion, failure policy in the service chain takes precedence. BLOCK is not supported for Endpoint protection (EPP) and MPS functionality.","title":"On Failure Policy","default":"ALLOW","enum":["ALLOW","BLOCK"],"readOnly":false,"type":"string"},"transports":{"description":"Transport Type of the service, which is the mechanism of redirecting the traffic to the the partner appliance. Transport type is required if Service caters to any functionality other than EPP and MPS.","title":"Transport Type","minItems":0,"items":{"enum":["L2_BRIDGE","L3_ROUTED","NSH"],"type":"string"},"readOnly":false,"maxItems":1,"type":"array"},"implementations":{"description":"This indicates the insertion point of the service i.e whether the service will be used to protect North-South or East-West traffic in the datacenter.","title":"Implementation Type","minItems":1,"items":{"enum":["NORTH_SOUTH","EAST_WEST"],"type":"string"},"readOnly":false,"maxItems":1,"type":"array"}}}],"description":"Registering a Service is the first step in the ServiceInsertion mechanism. A ServiceDefinition is used to create a service.","title":"Definition of a Service."},"NSAttributes":{"description":"NS Attributes data holder structure","title":"NS Attributes data holder structure","required":["attributes_data"],"x-vmw-nsx-module":"NSProfile","type":"object","properties":{"sub_attributes":{"items":{"$ref":"#/definitions/NSAttributesData"},"type":"array","description":"Reference to sub attributes for the attribute","title":"Reference to sub attributes for the attribute"},"attributes_data":{"$ref":"#/definitions/NSAttributesData"}}},"AntreaSupportBundleContainerNode":{"x-vmw-nsx-module":"MISSING_MODULE","allOf":[{"$ref":"#/definitions/SupportBundleContainerNode"},{"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"clusters":{"minItems":1,"items":{"$ref":"#/definitions/AntreaContainerClusterNode"},"type":"array","description":"List of AntreaContainerClusterNodes identifying container clusters and their nodes","title":"List of AntreaContainerClusterNodes identifying container clusters and their nodes"}}}]},"IntelligenceVsphereClusterNodeVMDeploymentConfig":{"x-vmw-nsx-module":"NsxIntelligenceDeployment","allOf":[{"$ref":"#/definitions/IntelligenceClusterNodeVMDeploymentConfig"},{"required":["storage_id","management_network_id","hostname","vc_id","compute_id"],"x-vmw-nsx-module":"NsxIntelligenceDeployment","type":"object","properties":{"ovf_url":{"type":"string","description":"The NSX-Intelligence cluster node VM OVF URL to download and install the OVF file.\nThis field is deprecated now. Please upload OVA file using \"/repository/bundles\" API\nand then try deployment without providing this field.\n","x-deprecated":true,"title":"URL of the ovf file to deploy"},"dns_servers":{"minItems":1,"items":{"description":"IPv4 address","format":"ipv4","type":"string"},"type":"array","description":"List of DNS servers.\nIf DHCP is used, the default DNS servers associated with\nthe DHCP server will be used instead.\nRequired if using static IP.\n","title":"DNS servers."},"display_name":{"type":"string","description":"Desired display name for NSX-Intelligence VM to be deployed\n","title":"NSX-Intelligence VM display name"},"ntp_servers":{"items":{"description":"Hostname or IPv4 address","format":"hostname-or-ipv4","type":"string"},"type":"array","description":"List of NTP servers.\nTo use hostnames, a DNS server must be defined. If not using DHCP,\na DNS server should be specified under dns_servers.\n","title":"NTP servers."},"management_network_id":{"type":"string","description":"Distributed portgroup identifier to which the management vnic of\nNSX-Intelligence cluster node VM will be connected.\n","title":"Portgroup identifier for management network connectivity"},"enable_ssh":{"default":false,"type":"boolean","description":"If true, the SSH service will automatically be started on the VM.\nEnabling SSH service is not recommended for security reasons.\n","title":"Enable SSH."},"allow_ssh_root_login":{"default":false,"type":"boolean","description":"If true, the root user will be allowed to log into the VM.\nAllowing root SSH logins is not recommended for security reasons.\n","title":"Allow root SSH logins."},"compute_id":{"type":"string","description":"The NSX-Intelligence cluster node VM will be deployed on the specified cluster or\nresourcepool for specified VC server.\n","title":"Cluster identifier or resourcepool identifier"},"disk_provisioning":{"description":"Specifies the disk provisioning type of the VM.\n","default":"THIN","enum":["THIN","LAZY_ZEROED_THICK","EAGER_ZEROED_THICK"],"type":"string"},"vc_id":{"type":"string","description":"The VC-specific identifiers will be resolved on this VC, so all other\nidentifiers specified in the config must belong to this vCenter server.\n","title":"Vsphere compute identifier for identifying VC server"},"storage_id":{"type":"string","description":"The NSX-Intelligence cluster node VM will be deployed on the specified datastore in\nthe specified VC server. User must ensure that storage is accessible\nby the specified cluster/host.\n","title":"Storage/datastore identifier"},"default_gateway_addresses":{"description":"The default gateway for the VM to be deployed must be specified if all\nthe other VMs it communicates with are not in the same subnet.\nDo not specify this field and management_port_subnets to use DHCP.\nNote: only single IPv4 default gateway address is supported and it\nmust belong to management network.\nIMPORTANT: VMs deployed using DHCP are currently not supported,\nso this parameter should be specified.\n","title":"Default gateway for the VM","minItems":1,"items":{"description":"IPv4 or IPv6 address","format":"ip","type":"string"},"maxItems":1,"type":"array"},"management_port_subnets":{"description":"IP Address and subnet configuration for the management port.\nDo not specify this field and default_gateway_addresses to use DHCP.\nNote: only one IPv4 address is supported for the management port.\nIMPORTANT: VMs deployed using DHCP are currently not supported,\nso this parameter should be specified.\n","title":"Port subnets for management port","minItems":1,"items":{"$ref":"#/definitions/IPSubnet"},"maxItems":1,"type":"array"},"host_id":{"type":"string","description":"The NSX-Intelligence cluster node VM will be deployed on the specified host in the\nspecified VC server within the cluster if host_id is specified.\nNote: User must ensure that storage and specified networks are\naccessible by this host.\n","title":"Host identifier"},"hostname":{"type":"string","description":"Desired host name/FQDN for the VM to be deployed\n","title":"Host name or FQDN for the VM"}}}],"description":"The Vsphere deployment configuration determines where to deploy the\nNSX-Intelligence cluster node VM through a vCenter server. It contains settings that are\napplied during install time.\nIf using DHCP, the following fields must be left unset - dns_servers,\nmanagement_port_subnets, and default_gateway_addresses\n","title":"Deployment config on the Vsphere platform"},"ContainerApplicationInstance":{"x-vmw-nsx-module":"InventoryContainerObj","allOf":[{"$ref":"#/definitions/DiscoveredResource"},{"required":["external_id"],"x-vmw-nsx-module":"InventoryContainerObj","type":"object","properties":{"status":{"readOnly":false,"enum":["UNKNOWN","HEALTHY","UP","DOWN","DEGRADED"],"type":"string","description":"Status of the container application instance.","title":"Status of the container application instance"},"network_status":{"readOnly":false,"enum":["HEALTHY","UNHEALTHY"],"type":"string","description":"Network status of container application instance.","title":"Network status of container application instance"},"container_cluster_id":{"readOnly":true,"type":"string","description":"Identifier of the container cluster this application instance belongs to.","title":"Identifier of the container cluster"},"cluster_node_id":{"readOnly":false,"type":"string","description":"Cluster node id where application instance is running.","title":"Cluster node id"},"external_id":{"readOnly":false,"type":"string","description":"Identifier of the container application instance on container cluster.","title":"External identifier of the container application instance"},"origin_properties":{"items":{"$ref":"#/definitions/KeyValuePair"},"readOnly":false,"type":"array","description":"Array of additional specific properties of container application instance\nin key-value format.\n","title":"Origin properties"},"container_application_ids":{"items":{"type":"string"},"readOnly":false,"type":"array","description":"List of identifiers of the container application.","title":"Identifiers of the container application"},"container_project_id":{"readOnly":false,"type":"string","description":"Identifier of the container project which this container application instance\nbelongs to.\n","title":"Identifier of the project"},"network_errors":{"items":{"$ref":"#/definitions/NetworkError"},"readOnly":false,"type":"array","description":"List of network errors related to container application instance.","title":"Network errors"}}}],"description":"Container application instance within a project.","title":"Container Application Instance"},"LiveTraceResult":{"x-vmw-nsx-module":"LiveTrace","type":"object","properties":{"pktcap_results":{"items":{"$ref":"#/definitions/PktCapResult"},"type":"array","description":"PktCap action results","title":"PktCap action results"},"trace_results":{"items":{"$ref":"#/definitions/TraceResult"},"type":"array","description":"Trace action observation list results","title":"Trace action observation list results"},"id":{"readOnly":true,"type":"string","description":"The id is assigned by Livetrace and cannot be specified by user.\n","title":"ID of a livetrace session"}}},"L2VPNSessionStatistics":{"x-vmw-nsx-module":"L2VPNStatistics","type":"object","description":"Session statistics gives VPN session status and traffic statistics per logical switch.","properties":{"traffic_statistics_per_logical_switch":{"items":{"$ref":"#/definitions/L2VPNPerLSTrafficStatistics"},"readOnly":true,"type":"array","description":"Traffic statistics per logical switch.","title":"Traffic statistics per logical switch"},"display_name":{"readOnly":true,"type":"string","description":"L2VPN display name.","title":"Display name"},"partial_stats":{"readOnly":true,"type":"boolean","description":"Partial statistics is set to true if onle active node responds while standby does not. In case of both nodes responded statistics will be summed and partial stats will be false. If cluster has only active node, partial statistics will always be false.","title":"Partial Statistics"},"session_id":{"readOnly":true,"type":"string","description":"Session identifier for L2VPN.","title":"L2VPN session id"},"tap_traffic_counters":{"items":{"$ref":"#/definitions/L2VPNTapTrafficStatistics"},"readOnly":true,"type":"array","description":"Tunnel port traffic counters.","title":"Tunnel port traffic counters"}},"title":"L2VPN session statistics"},"ControllerClusterRoleConfig":{"x-vmw-nsx-module":"ClusterManagement","allOf":[{"$ref":"#/definitions/ClusterRoleConfig"},{"x-vmw-nsx-module":"ClusterManagement","type":"object","properties":{"mpa_msg_client_info":{"$ref":"#/definitions/MsgClientInfo"},"host_msg_client_info":{"$ref":"#/definitions/MsgClientInfo"},"control_plane_listen_addr":{"$ref":"#/definitions/ServiceEndpoint"},"control_cluster_listen_addr":{"$ref":"#/definitions/ServiceEndpoint"}}}]},"LbServiceStatisticsCounter":{"x-vmw-nsx-module":"AggSvcLb","type":"object","properties":{"l4_total_sessions":{"format":"int64","type":"integer","description":"Number of l4 total sessions","title":"Number of l4 total sessions"},"l7_current_sessions":{"format":"int64","type":"integer","description":"Number of l7 current sessions","title":"Number of l7 current sessions"},"l4_max_sessions":{"format":"int64","type":"integer","description":"L4 max sessions is used to show the peak L4 max session data since\nload balancer starts to provide service.\n","title":"Number of l4 maximum sessions"},"l4_current_sessions":{"format":"int64","type":"integer","description":"Number of l4 current sessions","title":"Number of l4 current sessions"},"l7_total_sessions":{"format":"int64","type":"integer","description":"Number of l7 total sessions","title":"Number of l7 total sessions"},"l4_current_session_rate":{"type":"number","description":"The average number of l4 current sessions per second, the number is\naveraged over the last 5 one-second intervals.\n","title":"The average number of l4 current sessions per second, the number is\naveraged over the last 5 one-second intervals.\n"},"l7_current_session_rate":{"type":"number","description":"The average number of l7 current requests per second, the number is\naveraged over the last 5 one-second intervals.\n","title":"The average number of l7 current requests per second, the number is\naveraged over the last 5 one-second intervals.\n"},"l7_max_sessions":{"format":"int64","type":"integer","description":"L7 max sessions is used to show the peak L7 max session data since\nload balancer starts to provide service.\n","title":"Number of l7 maximum sessions"}}},"VniPoolListResult":{"x-vmw-nsx-module":"Vnim","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"Vnim","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/VniPool"},"type":"array","description":"VNI pool list results","title":"VNI pool list results"}}}]},"LbService":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"access_log_enabled":{"type":"boolean","description":"Whether access log is enabled","x-deprecated":true,"title":"Whether access log is enabled"},"attachment":{"$ref":"#/definitions/ResourceReference"},"error_log_level":{"description":"Load balancer engine writes information about encountered issues of\ndifferent severity levels to the error log. This setting is used to\ndefine the severity level of the error log.\n","default":"INFO","enum":["DEBUG","INFO","WARNING","ERROR","CRITICAL","ALERT","EMERGENCY"],"type":"string"},"virtual_server_ids":{"items":{"type":"string"},"type":"array","description":"virtual servers can be associated to LbService(which is\nsimilar to physical/virtual load balancer), Lb virtual servers,\npools and other entities could be defined independently, the virtual\nserver identifier list here would be used to maintain the relationship of\nLbService and other Lb entities.\n","title":"Virtual server identifier list"},"relax_scale_validation":{"default":false,"type":"boolean","description":"If relax_scale_validation is true, the scale validations for virtual\nservers/pools/pool members/rules are relaxed for load balancer service.\nWhen load balancer service is deployed on edge nodes, the scale of\nvirtual servers/pools/pool members for the load balancer service should\nnot exceed the scale number of the largest load balancer size which\ncould be configured on a certain edge form factor. For example, the\nlargest load balancer size supported on a MEDIUM edge node is MEDIUM.\nSo one SMALL load balancer deployed on MEDIUM edge nodes can support\nthe scale number of MEDIUM load balancer. It is not recommended to\nenable active monitors if relax_scale_validation is true due to\nperformance consideration.\nIf relax_scale_validation is false, scale numbers should be validated\nfor load balancer service.\nThe property is deprecated as NSX-T Load Balancer is deprecated.\n","x-deprecated":true,"title":"Whether scale validation is relaxed"},"enabled":{"default":true,"type":"boolean","description":"Whether the load balancer service is enabled","title":"Whether the load balancer service is enabled"},"size":{"description":"The size of load balancer service","default":"SMALL","enum":["SMALL","MEDIUM","LARGE","XLARGE","DLB"],"type":"string"}}}]},"CrlDistributionPointList":{"x-vmw-nsx-module":"CertificateManager","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"CertificateManager","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/CrlDistributionPoint"},"readOnly":false,"type":"array","description":"CrlDistributionPoint list."}}}],"description":"CrlDistributionPoint query result","title":"CrlDistributionPoint query result"},"ResourceAssignment":{"x-vmw-nsx-module":"FabricNode","type":"object","description":"Amount of memory and CPU allocated to the Edge VM.\n","properties":{"memory_allocation_in_mb":{"description":"Memory allocation in MB.\n","format":"int32","title":"Memory allocation in MB.","readOnly":true,"minimum":0,"type":"integer"},"cpu_count":{"description":"CPU count.\n","format":"int32","title":"CPU count.","readOnly":true,"minimum":0,"type":"integer"}}},"NextHopPrefixListsMapping":{"description":"Next hop to prefix lists mapping.","title":"Next hop to prefix lists mapping","required":["prefix_lists","next_hop"],"x-vmw-nsx-module":"LogicalRouterPorts","type":"object","properties":{"prefix_lists":{"description":"Array of Prefix list UUIDs.","title":"Prefix list UUIDs","minItems":1,"items":{"type":"string"},"maxItems":1,"type":"array"},"next_hop":{"type":"string","description":"Next hop address.","title":"Next hop address"}}},"IPInfo":{"x-vmw-nsx-module":"ServiceInsertionCommonTypes","required":["ip_addresses","prefix_length"],"type":"object","properties":{"ip_addresses":{"description":"IPv4 Addresses","title":"IPv4 Addresses","minItems":1,"items":{"description":"IPv4 address","format":"ipv4","type":"string"},"maxItems":1,"type":"array"},"prefix_length":{"description":"Subnet Prefix Length","format":"int64","title":"Subnet Prefix Length","maximum":32,"minimum":1,"type":"integer"}}},"CrlObjectData":{"x-vmw-nsx-module":"CertificateManager","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"CertificateManager","type":"object","properties":{"crl_type":{"default":"X509","enum":["OneCRL","X509"],"type":"string","description":"The type of the CRL. It can be \"OneCRL\" or \"X509\" (default).","title":"Type of CRL"},"pem_encoded":{"readOnly":false,"type":"string","description":"PEM encoded CRL data."},"one_crl":{"readOnly":false,"type":"string","description":"JSON-encoded OneCRL-like object","title":"JSON-encoded OneCRL-like object"}}}]},"VendorTemplateListResult":{"x-vmw-nsx-module":"ServiceInsertion","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"ServiceInsertion","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/VendorTemplate"},"readOnly":true,"type":"array","description":"List of the Service-Insertion Services. The list has to be homogenous.","title":"Service list"}}}],"description":"Vendor Template List","title":"Vendor Template List"},"TunnelList":{"x-vmw-nsx-module":"Tunnel","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"Tunnel","type":"object","properties":{"tunnels":{"items":{"$ref":"#/definitions/TunnelProperties"},"readOnly":true,"type":"array","description":"List of transport node tunnels","title":"List of transport node tunnels"}}}]},"LbServiceInstanceDetail":{"x-vmw-nsx-module":"AggSvcLb","type":"object","properties":{"error_message":{"type":"string","description":"The error message for the load balancer instance. If the instance\nstatus is NOT_READY, error message will be attached.\n","title":"The error message for this instance"},"attachment":{"$ref":"#/definitions/ResourceReference"}}},"LbCookieTime":{"discriminator":"type","x-vmw-nsx-module":"LoadBalancer","required":["type"],"type":"object","properties":{"type":{"description":"Both session cookie and persistence cookie are supported,\nUse LbSessionCookieTime for session cookie time setting,\nUse LbPersistenceCookieTime for persistence cookie time setting\n","enum":["LbSessionCookieTime","LbPersistenceCookieTime"],"type":"string"}}},"FullSyncStatus":{"x-vmw-nsx-module":"SiteManagerModule","required":["status","completed_at","sync_id","sync_type","snapshot_version"],"type":"object","properties":{"status":{"enum":["UNAVAILABLE","ERROR","ONGOING","COMPLETE","NOT_STARTED"],"type":"string","description":"Status of full sync.","title":"Status of full sync."},"completed_at":{"type":"string","description":"Time at which the full sync was completed.","title":"Time at which the full sync was completed."},"sync_id":{"type":"string","description":"Identifier for the full sync.","title":"Identifier for the full sync."},"sync_type":{"enum":["UNAVAILABLE","STANDARD","FORCED"],"type":"string","description":"Type of full sync.","title":"Type of full sync."},"snapshot_version":{"type":"string","description":"Snapshot version targeted by full sync.","title":"Snapshot version targeted by full sync."}}},"DhcpRelayService":{"x-vmw-nsx-module":"DhcpRelay","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"DhcpRelay","required":["dhcp_relay_profile_id"],"type":"object","properties":{"dhcp_relay_profile_id":{"type":"string","description":"dhcp relay profile referenced by the dhcp relay service","title":"dhcp relay profile referenced by the dhcp relay service"}}}]},"ServiceConfigList":{"description":"List of Service config objects that needs to be either created\nor updated with the respective profiles and precedence.\n","title":"List of Service Configs for batch operation","required":["service_configs"],"x-vmw-nsx-module":"ServiceConfig","type":"object","properties":{"service_configs":{"description":"An Array of ServiceConfig objects containing details of\nprofiles to be applied, entities on which these profiles\nwill be applied and precedence.\n","title":"service config list results","minItems":1,"items":{"$ref":"#/definitions/ServiceConfig"},"maxItems":100,"type":"array"}}},"IngressRateShaper":{"x-vmw-nsx-module":"QosSwitchingProfile","allOf":[{"$ref":"#/definitions/QosBaseRateShaper"},{"x-vmw-nsx-module":"QosSwitchingProfile","type":"object","properties":{"average_bandwidth_mbps":{"description":"Average bandwidth in Mb/s","format":"int32","default":0,"title":"Average bandwidth in Mb/s","minimum":0,"type":"integer"},"peak_bandwidth_mbps":{"description":"Peak bandwidth in Mb/s","format":"int32","default":0,"title":"Peak bandwidth in Mb/s","minimum":0,"type":"integer"},"burst_size_bytes":{"description":"Burst size in bytes","format":"int32","default":0,"title":"Burst size in bytes","minimum":0,"type":"integer"}}}],"description":"A shaper that specifies ingress rate properties in Mb/s","title":"A shaper that specifies ingress rate properties in Mb/s"},"RouteBasedIPSecVPNSession":{"x-vmw-nsx-module":"IPSecVPN","allOf":[{"$ref":"#/definitions/IPSecVPNSession"},{"required":["tunnel_ports"],"x-vmw-nsx-module":"IPSecVPN","type":"object","properties":{"tunnel_ports":{"description":"IP Tunnel ports.","title":"IP Tunnel ports","minItems":1,"items":{"$ref":"#/definitions/TunnelPortConfig"},"maxItems":1,"type":"array"}}}],"description":"A Route Based VPN is more flexible, more powerful and recommended over policy based VPN. IP Tunnel port is created and all traffic routed via tunnel port is protected. Routes can be configured statically or can be learned through BGP. A route based VPN is must for establishing redundant VPN session to remote site.","title":"Route based VPN session"},"TimeRangeDropdownFilterWidgetConfiguration":{"x-vmw-nsx-module":"NsxDashboard","allOf":[{"$ref":"#/definitions/DropdownFilterWidgetConfiguration"},{"x-vmw-nsx-module":"NsxDashboard","type":"object","properties":{"time_range_filter_info":{"$ref":"#/definitions/TimeRangeFilterInfo"}}}],"description":"Represents configuration for dropdown filter widget for Time Range.","title":"Time Range Dropdown Filter widget Configuration"},"LogicalDhcpServerListResult":{"x-vmw-nsx-module":"Dhcp","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"Dhcp","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/LogicalDhcpServer"},"type":"array","description":"A paginated list of logical DHCP servers.","title":"Paginated list of DHCP servers"}}}],"description":"A paginated list of logical DHCP servers.","title":"A list of logical DHCP servers"},"HostSwitchInfo":{"x-vmw-nsx-module":"TransportZone","type":"object","description":"Information of host switch participating in transport zone","properties":{"host_switch_type":{"readOnly":true,"enum":["NVDS","VDS"],"type":"string","description":"Type of a host switch","title":"Type of a host switch"},"host_switch_id":{"readOnly":true,"type":"string","description":"Unique ID of a host switch","title":"Unique ID of a host switch"},"host_switch_mode":{"readOnly":true,"enum":["STANDARD","ENS","ENS_INTERRUPT"],"type":"string","description":"Mode of host switch","title":"Mode of host switch"},"host_switch_name":{"readOnly":true,"type":"string","description":"Name of a host switch","title":"Name of a host switch"}},"title":"Information of host switch participating in transport zone"},"DropdownFilterPlotConfiguration":{"x-vmw-nsx-module":"NsxDashboard","allOf":[{"$ref":"#/definitions/WidgetPlotConfiguration"},{"x-vmw-nsx-module":"NsxDashboard","type":"object","properties":{"allow_search":{"default":false,"type":"boolean","description":"Allow search on drop down filter.\n","title":"Allow search on drop down filter"}}}],"description":"Dropdown Filter plotting configuration.","title":"Dropdown Filtert plotting configuration"},"Axes":{"x-vmw-nsx-module":"NsxDashboard","type":"object","description":"Represents X and Y axes of a graph. For a multi-graph, the same axes are shared by all the graphs.","properties":{"y_labels":{"minItems":0,"items":{"$ref":"#/definitions/Label"},"type":"array","description":"A list of Y-Axis Labels with condition support. If needed, this property can be used to provide a list of y-axis label with condition support. For a label with single condition,'y-label' property can be used.","title":"A list of Y-Axis Labels with condition support."},"y_axis_unit_labels":{"minItems":0,"items":{"$ref":"#/definitions/Label"},"type":"array","description":"A list of Y-Axis unit Labels with condition support. If needed, this property can be used to provide a list of y-axis unit label with condition support. This unit label can be used to display the point value along with units like percentage, milliseconds etc.","title":"A list of Y-Axis unit Labels with condition support."},"x_labels":{"minItems":0,"items":{"$ref":"#/definitions/Label"},"type":"array","description":"A list of X-Axis Labels with condition support. If needed, this property can be used to provide a list of x-axis label with condition support. For a label with single condition,'x-label' property can be used.","title":"A list of X-Axis Labels with condition support."},"x_label":{"$ref":"#/definitions/Label"},"y_label":{"$ref":"#/definitions/Label"},"y_axis_units":{"minItems":0,"items":{"$ref":"#/definitions/AxisUnit"},"type":"array","description":"A list of Y-Axis unit with condition support. If needed, this property can be used to provide a list of y-axis unit with condition support. This unit could be like percentage, seconds, milliseconds etc.","title":"A list of Y-Axis unit with condition support."}},"title":"Axes of a graph"},"UpgradeCheckListResult":{"x-vmw-nsx-module":"Upgrade","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"Upgrade","required":["checks"],"type":"object","properties":{"checks":{"items":{"$ref":"#/definitions/UpgradeCheck"},"type":"array","description":"Paged Collection of pre/post-upgrade checks","title":"Paged Collection of pre/post-upgrade checks"}}}]},"ErrorResolverUserMetadata":{"x-vmw-nsx-module":"ErrorResolver","type":"object","description":"User supplied metadata needed for resolving errors","properties":{"user_input_list":{"items":{"$ref":"#/definitions/ErrorResolverUserInputData"},"type":"array","description":"List of user supplied input data.","title":"List of user supplied input data."}}},"ListResult":{"x-vmw-nsx-module":"Common","allOf":[{"$ref":"#/definitions/Resource"},{"x-vmw-nsx-module":"Common","type":"object","properties":{"cursor":{"readOnly":true,"type":"string","description":"Opaque cursor to be used for getting next page of records (supplied by current result page)","title":"Opaque cursor to be used for getting next page of records (supplied by current result page)"},"sort_ascending":{"readOnly":true,"type":"boolean","description":"If true, results are sorted in ascending order","title":"If true, results are sorted in ascending order"},"sort_by":{"readOnly":true,"type":"string","description":"Field by which records are sorted","title":"Field by which records are sorted"},"result_count":{"readOnly":true,"format":"int64","type":"integer","description":"Count of results found (across all pages), set only on first page","title":"Count of results found (across all pages), set only on first page"}}}],"description":"Base class for list results from collections","title":"Base class for list results from collections"},"L2ForwarderRemoteMacs":{"x-vmw-nsx-module":"AggSvcL2Forwarder","type":"object","properties":{"last_update_timestamp":{"description":"Timestamp when the l2 forwarder remote mac addresses was last updated.\n","format":"int64","readOnly":true,"type":"integer"},"logical_switch_id":{"readOnly":true,"type":"string","description":"Logical switch id on which the L2 forwarder is created.\n","title":"Logical switch id of L2 forwarder"},"remote_macs_per_site":{"items":{"$ref":"#/definitions/L2ForwarderRemoteMacsPerSite"},"readOnly":true,"type":"array","description":"L2 forwarder remote mac addresses per site for logical switch.\n","title":"L2 forwarder remote mac addresses per site"},"inter_site_forwarder_status":{"items":{"$ref":"#/definitions/L2ForwarderStatusPerNode"},"readOnly":true,"type":"array","description":"Inter-site forwarder status per node.","title":"Inter-site forwarder status per node"}}},"UpgradeTopology":{"description":"Recommended topology for migrating NVDS to VDS","title":"Recommended topology for migrating NVDS to VDS","required":["topology"],"x-vmw-nsx-module":"NvdsUpgradeReadinessCheck","type":"object","properties":{"topology":{"items":{"$ref":"#/definitions/NvdsUpgradeTopology"},"type":"array","description":"All resultant VDS mapping for a NVDS after the migration","title":"All resultant VDS mapping for a NVDS after the migration"}}},"DhcpIpPoolUsage":{"x-vmw-nsx-module":"AggSvcDhcp","required":["allocated_percentage","pool_size","allocated_number","dhcp_ip_pool_id"],"type":"object","properties":{"allocated_percentage":{"format":"int64","type":"integer","description":"allocated percentage. COULD BE INACCURATE, REFERENCE ONLY.","title":"allocated percentage. COULD BE INACCURATE, REFERENCE ONLY."},"pool_size":{"format":"int64","type":"integer","description":"pool size","title":"pool size"},"allocated_number":{"format":"int64","type":"integer","description":"allocated number. COULD BE INACCURATE, REFERENCE ONLY.","title":"allocated number. COULD BE INACCURATE, REFERENCE ONLY."},"dhcp_ip_pool_id":{"type":"string","description":"uuid of dhcp ip pool","title":"uuid of dhcp ip pool"}}},"AdvanceClusterRestoreInput":{"x-vmw-nsx-module":"ClusterRestore","required":["resources"],"type":"object","properties":{"id":{"readOnly":true,"type":"string","description":"Unique id of an instruction (as returned by the GET /restore/status\ncall) for which input is to be provided\n","title":"Unique id of an instruction (as returned by the GET /restore/status\ncall) for which input is to be provided\n"},"resources":{"items":{"$ref":"#/definitions/SelectableResourceReference"},"type":"array","description":"List of resources for which the instruction is applicable.","title":"List of resources for which the instruction is applicable."}}},"UnboundedKeyValuePair":{"description":"A key-value pair with no limitations on size","title":"A key-value pair with no limitations on size","required":["value","key"],"x-vmw-nsx-module":"Common","type":"object","properties":{"value":{"readOnly":false,"type":"string","description":"Value","title":"Value"},"key":{"readOnly":false,"type":"string","description":"Key","title":"Key"}}},"AllocationIpAddress":{"x-vmw-nsx-module":"Ipam","description":"Allocation parameters for the IP address (e.g. specific IP address) can be specified. Tags, display_name and description attributes are not supported in this release.","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"Ipam","type":"object","properties":{"allocation_id":{"description":"Address that is allocated from pool","format":"ip","readOnly":true,"type":"string"}}}]},"TelemetryAgreement":{"x-vmw-nsx-module":"TelemetryConfig","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"TelemetryConfig","required":["telemetry_agreement_displayed"],"type":"object","properties":{"telemetry_agreement_displayed":{"type":"boolean","description":"Determine if telemetry agreement has been displayed. If false,\nthe agreement text will be displayed at login time.\n","title":"Flag to indicate if telemetry agreement has been displayed"}}}]},"IdfwUserSessionDataAndMappings":{"description":"Identity Firewall user session data list and Directory Group to user mappings.\n","title":"Identity Firewall user session data list and Directory Group to user mappings","required":["archived_user_sessions","active_user_sessions","dir_group_to_user_session_data_mappings"],"x-vmw-nsx-module":"IdentityFirewall","type":"object","properties":{"archived_user_sessions":{"items":{"$ref":"#/definitions/IdfwUserSessionData"},"type":"array","description":"Archived user session data list","title":"Archived user session data list"},"active_user_sessions":{"items":{"$ref":"#/definitions/IdfwUserSessionData"},"type":"array","description":"Active user session data list","title":"Active user session data list"},"dir_group_to_user_session_data_mappings":{"items":{"$ref":"#/definitions/IdfwDirGroupUserSessionMapping"},"type":"array","description":"Directory Group to user session data mappings","title":"Directory Group to user session data mappings"}}},"AdvertiseRuleList":{"x-vmw-nsx-module":"Routing","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"Routing","type":"object","properties":{"rules":{"description":"List of advertisement rules","title":"List of advertisement rules","default":[],"items":{"$ref":"#/definitions/AdvertiseRule"},"minItems":0,"type":"array"},"logical_router_id":{"readOnly":true,"type":"string","description":"Logical router id","title":"Logical router id"}}}]},"SupportBundleFileTransferAuthenticationScheme":{"x-vmw-nsx-module":"MISSING_MODULE","required":["username","scheme_name"],"type":"object","properties":{"username":{"type":"string","description":"User name to authenticate with","title":"User name to authenticate with"},"scheme_name":{"enum":["PASSWORD"],"type":"string","description":"Authentication scheme name","title":"Authentication scheme name"},"password":{"type":"string","description":"Password to authenticate with","title":"Password to authenticate with"}}},"MigrationUnitTypeStats":{"x-vmw-nsx-module":"Migration","type":"object","properties":{"node_with_issues_count":{"readOnly":true,"format":"int32","type":"integer","description":"Number of nodes with issues that may cause migration failure","title":"Number of nodes with issues that may cause migration failure"},"node_count":{"readOnly":true,"format":"int32","type":"integer","description":"Number of nodes","title":"Number of nodes"},"version":{"readOnly":true,"type":"string","description":"Version of the migration unit","title":"Version of the migration unit"},"type":{"readOnly":true,"type":"string","description":"Type of migration unit","title":"Type of migration unit"}}},"TraceflowObservationDroppedLogical":{"x-vmw-nsx-module":"Traceflow","allOf":[{"$ref":"#/definitions/TraceflowObservationDropped"},{"x-vmw-nsx-module":"Traceflow","type":"object","properties":{"service_path_index":{"readOnly":true,"format":"int64","type":"integer","description":"The index of service path that is a chain of services\nrepresents the point where the traceflow packet was dropped.\n","title":"The index of service path"},"component_id":{"readOnly":true,"type":"string","description":"The id of the component that dropped the traceflow packet.","title":"The id of the component that dropped the traceflow packet."}}}]},"RedistributionConfig":{"x-vmw-nsx-module":"Routing","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"Routing","type":"object","properties":{"logical_router_id":{"readOnly":true,"type":"string","description":"Logical router id","title":"Logical router id"},"bgp_enabled":{"default":false,"type":"boolean","description":"Flag to enable redistribution for BGP as destination protocol","title":"Flag to enable redistribution for BGP as destination protocol"}}}]},"IdfwTransportNodeStatus":{"description":"ID and status of the Identity Firewall enabled Compute collection's\ntransport node.\n","title":"IDFW transport node ID and status.","required":["transport_node_status","transport_node_id"],"x-vmw-nsx-module":"IdentityFirewall","type":"object","properties":{"transport_node_status":{"items":{"$ref":"#/definitions/IdfwTransportNodeCondition"},"type":"array","description":"Status of the IDFW transport node.","title":"IDFW TransportNode status."},"transport_node_id":{"type":"string","description":"TransportNode ID of the Identity Firewall enabled Compute\ncollection's transport node.\n","title":"IDFW TransportNode ID."}}},"FilterWidgetConfiguration":{"x-vmw-nsx-module":"NsxDashboard","allOf":[{"$ref":"#/definitions/WidgetConfiguration"},{"x-vmw-nsx-module":"NsxDashboard","type":"object","properties":{"alias":{"type":"string","description":"Alias to be used when emitting filter value.","title":"Alias to be used when emitting filter value"}}}],"description":"Represents configuration for filter widget. This is abstract representation of filter widget.","title":"Filter widget Configuration"},"FeedBackErrorMessage":{"description":"Provide details of error_id and error description for errors occurred during collection\n,translation and apply phase in MP to Policy promotion.\n","title":"FeedBackErrorMessage","required":["error_desc","error_id"],"x-vmw-nsx-module":"MPPolicyMigration","type":"object","properties":{"error_desc":{"type":"string","description":"Error description due to which promotion is not successful.","title":"Error description due to which promotion is not successful."},"error_id":{"type":"string","description":"Error Id due to which promotion is not successful.","title":"Error Id due to which promotion is not successful."}}},"ContainerIngressPolicyListResult":{"x-vmw-nsx-module":"InventoryContainerObj","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"InventoryContainerObj","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/ContainerIngressPolicy"},"type":"array","description":"List of Container Ingress Policy specs","title":"List of Container Ingress Policy specs"}}}]},"LbServerSslProfile":{"x-vmw-nsx-module":"LoadBalancer","description":"The object is deprecated as NSX-T Load Balancer is deprecated.\n","allOf":[{"$ref":"#/definitions/LbSslProfile"},{"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"session_cache_enabled":{"default":true,"type":"boolean","description":"SSL session caching allows SSL client and server to reuse previously\nnegotiated security parameters avoiding the expensive public key\noperation during handshake.\n","title":"session cache enable/disable falg"},"is_fips":{"readOnly":true,"type":"boolean","description":"This flag is set to true when all the ciphers and protocols are FIPS\ncompliant.\nIt is set to false when one of the ciphers or protocols are not\nFIPS compliant.\n","title":"FIPS compliance of ciphers and protocols"},"cipher_group_label":{"description":"It is a label of cipher group which is mostly consumed by GUI.\n","enum":["BALANCED","HIGH_SECURITY","HIGH_COMPATIBILITY","CUSTOM"],"type":"string"},"is_secure":{"readOnly":true,"type":"boolean","description":"This flag is set to true when all the ciphers and protocols are secure.\nIt is set to false when one of the ciphers or protocols is insecure.\n","title":"Secure/Insecure SSL profile flag"},"ciphers":{"items":{"description":"SSL cipher","enum":["TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256","TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384","TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA","TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA","TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA","TLS_ECDH_RSA_WITH_AES_256_CBC_SHA","TLS_RSA_WITH_AES_256_CBC_SHA","TLS_RSA_WITH_AES_128_CBC_SHA","TLS_RSA_WITH_3DES_EDE_CBC_SHA","TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA","TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256","TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384","TLS_RSA_WITH_AES_128_CBC_SHA256","TLS_RSA_WITH_AES_128_GCM_SHA256","TLS_RSA_WITH_AES_256_CBC_SHA256","TLS_RSA_WITH_AES_256_GCM_SHA384","TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA","TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256","TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256","TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384","TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384","TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA","TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256","TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256","TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384","TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384","TLS_ECDH_RSA_WITH_AES_128_CBC_SHA","TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256","TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256","TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384","TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384"],"type":"string"},"type":"array","description":"supported SSL cipher list to client side","title":"supported SSL cipher list to client side"},"protocols":{"items":{"description":"SSL protocol","enum":["SSL_V2","SSL_V3","TLS_V1","TLS_V1_1","TLS_V1_2"],"type":"string"},"type":"array","description":"SSL versions TLS1.1 and TLS1.2 are supported and enabled by default.\nSSLv2, SSLv3, and TLS1.0 are supported, but disabled by default.\n","title":"supported SSL protocol list to client side"}}}]},"IDSEventDataRequest":{"x-vmw-nsx-module":"IDSMetrics","type":"object","description":"Filtering parameters to get only a subset of intrusion events.","properties":{"filters":{"items":{"$ref":"#/definitions/FilterRequest"},"type":"array","description":"An array of filter conditions.","title":"Filter conditions"}},"title":"Parameters to filter list of intrusions"},"ApiServiceConfig":{"x-vmw-nsx-module":"MISSING_MODULE","type":"object","description":"Properties that affect the configuration of the NSX API service.\n","properties":{"global_api_concurrency_limit":{"description":"The maximum number of concurrent API requests that will be serviced. If the number of API requests being processed exceeds this limit, new API requests will be refused and a 503 Service Unavailable response will be returned to the client. To disable API concurrency limiting, set this value to 0.","format":"int64","default":199,"title":"Global API rate limit in calls","minimum":0,"type":"integer"},"lockout_immune_addresses":{"items":{"description":"IPv4 or IPv6 address","format":"ip","type":"string"},"type":"array","description":"The list of IP addresses which are not subjected to a lockout on failed login attempts.","title":"IP addresses which are not subject to lockout on failed login attempts"},"basic_authentication_enabled":{"default":true,"type":"boolean","description":"Identifies whether basic authentication is enabled or disabled in API calls.","title":"Enable or disable basic authentication"},"redirect_host":{"description":"Host name or IP address to use for redirect location headers, or empty string to derive from current request. To disable, set redirect_host to the empty string (\"\").","default":"","pattern":"/^(?=.{1,255}$)[0-9A-Za-z](?:(?:[0-9A-Za-z]|-){0,61}[0-9A-Za-z])?(?:\\.[0-9A-Za-z](?:(?:[0-9A-Za-z]|-){0,61}[0-9A-Za-z])?)*\\.?$|^$/","type":"string"},"cipher_suites":{"minItems":1,"items":{"$ref":"#/definitions/CipherSuite"},"type":"array","description":"The TLS cipher suites that the API service will negotiate.","title":"Cipher suites used to secure contents of connection"},"cookie_based_authentication_enabled":{"default":true,"type":"boolean","description":"Identifies whether cookie-based authentication is enabled or disabled in API calls. When cookie-based authentication is disabled, new sessions cannot be created via /api/session/create.","title":"Enable or disable cookie-based authentication"},"session_timeout":{"description":"NSX session inactivity timeout","title":"NSX session inactivity timeout","default":1800,"format":"int64","maximum":2147483647,"minimum":0,"type":"integer"},"client_api_rate_limit":{"description":"The maximum number of API requests that will be serviced per second for a given authenticated client. If more API requests are received than can be serviced, a 429 Too Many Requests HTTP response will be returned. To disable API rate limiting, set this value to 0.","format":"int64","default":100,"title":"Client API rate limit in calls per second","minimum":0,"type":"integer"},"client_api_concurrency_limit":{"description":"The maximum number of concurrent API requests that will be serviced for a given authenticated client. If the number of API requests being processed exceeds this limit, new API requests will be refused and a 503 Service Unavailable response will be returned to the client. To disable API concurrency limiting, set this value to 0.","format":"int64","default":40,"title":"Client API rate limit in calls","minimum":0,"type":"integer"},"protocol_versions":{"minItems":1,"items":{"$ref":"#/definitions/ProtocolVersion"},"type":"array","description":"The TLS protocol versions that the API service will negotiate.","title":"TLS protocol versions"},"connection_timeout":{"description":"NSX connection timeout, in seconds. To disable timeout, set to 0.","title":"NSX connection timeout","default":30,"format":"int64","maximum":2147483647,"minimum":0,"type":"integer"}},"title":"Configuration of the API service"},"LbSslModeSelectionAction":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/LbRuleAction"},{"required":["ssl_mode"],"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"ssl_mode":{"enum":["SSL_PASSTHROUGH","SSL_END_TO_END","SSL_OFFLOAD"],"type":"string","description":"SSL Passthrough: LB establishes a TCP connection with client and another\nconnection with selected backend server. LB won't inspect the stream\ndata between client and backend server, but just pass it through.\nBackend server exchanges SSL connection with client.\nSSL Offloading: LB terminiates the connections from client, and\nestablishes SSL connection with it. After receiving the HTTP request,\nLB connects the selected backend server and talk with it via HTTP\nwithout SSL. LB estalishes new connection to selected backend server\nfor each HTTP request, in case server_keep_alive or multiplexing are\nNOT configured.\nSSL End-to-End: LB terminiates the connections from client, and\nestablishes SSL connection with it. After receiving the HTTP request,\nLB connects the selected backend server and talk with it via HTTPS.\nLB estalishes new SSL connection to selected backend server for each\nHTTP request, in case server_keep_alive or multiplexing are NOT\nconfigured.\n","title":"Type of SSL mode"}}}],"description":"This action is used to select SSL mode. Three types of SSL mode actions can\nbe specified in Transport phase, ssl passthrough, ssl offloading and ssl\nend-to-end.\n","title":"Action to select SSL mode"},"LogicalRouterStatus":{"x-vmw-nsx-module":"AggSvcLogicalRouter","required":["logical_router_id"],"type":"object","properties":{"last_update_timestamp":{"description":"Timestamp when the data was last updated; unset if data source has never updated the data.","format":"int64","readOnly":true,"type":"integer"},"logical_router_id":{"type":"string","description":"The id of the logical router","title":"The id of the logical router"},"per_node_status":{"items":{"$ref":"#/definitions/LogicalRouterStatusPerNode"},"readOnly":true,"type":"array","description":"Per Node Status","title":"Per Node Status"},"locale_operation_mode":{"readOnly":true,"enum":["PRIMARY_LOCATION","SECONDARY_LOCATION"],"type":"string","description":"Egress mode for the logical router at given mode\n","title":"Location mode for logical router"}}},"DhcpProfileListResult":{"x-vmw-nsx-module":"Dhcp","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"Dhcp","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/DhcpProfile"},"type":"array","description":"A paginated list of logical DHCP profiles.","title":"Paginated list of DHCP profiles"}}}],"description":"A paginated list of DHCP profiles.","title":"A list of DHCP profiles"},"CsrExtensions":{"x-vmw-nsx-module":"CertificateManager","type":"object","description":"Collection of various x509 v3 extensions to be added to a CSR","properties":{"subject_alt_names":{"$ref":"#/definitions/SubjectAltNames"}},"title":"Collection of various x509 v3 extensions to be added to a CSR"},"Snmpv2cTarget":{"description":"This object contains SNMP v2c target/receiver where SNMP traps/notifications will be sent.","title":"SNMP v2c target","required":["community_name","server"],"x-vmw-nsx-module":"CentralConfig","type":"object","properties":{"community_name":{"minLength":1,"maxLength":64,"type":"string","description":"Unique non-sensitive community name to identify community.","title":"Community name"},"community_string":{"minLength":1,"maxLength":64,"type":"string","description":"Community string (shared secret). This field is required when adding a community target. When updating a community target, do not include this field in the request. If this field is present in an update request, it will be considered as a new value for community string.","title":"Community string"},"port":{"description":"SNMP v2c target server's port number.","title":"SNMP v2c target server port","default":162,"format":"int64","maximum":65535,"minimum":1,"type":"integer"},"server":{"description":"SNMP v2c target server's IP or FQDN.","format":"hostname-or-ipv4","type":"string"}}},"BackupUiFramesInfoList":{"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"backup_frames_list":{"items":{"$ref":"#/definitions/BackupUiFramesInfo"},"readOnly":true,"type":"array","description":"List of backup frames(and metadata) to be displayed in UI","title":"List of backup frames(and metadata) to be displayed in UI"}}},"VirtualPortgroup":{"x-vmw-nsx-module":"InventoryCmObj","allOf":[{"$ref":"#/definitions/DiscoveredResource"},{"x-vmw-nsx-module":"InventoryCmObj","type":"object","properties":{"external_id":{"readOnly":true,"type":"string","description":"External id of the virtual portgroup","title":"External id of the virtual portgroup"},"origin_type":{"readOnly":true,"type":"string","description":"Portgroup type like DistributedVirtualPortgroup","title":"Portgroup type like DistributedVirtualPortgroup"},"cm_local_id":{"readOnly":true,"type":"string","description":"Id of the portgroup, eg. a mo-ref from VC.","title":"Id of the portgroup in compute manager"}}}],"description":"Virtual portgroup on a virtual switch","title":"Virtual portgroup on a virtual switch"},"DnsForwarder":{"x-vmw-nsx-module":"DnsForwarder","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"DnsForwarder","required":["default_forwarder","logical_router_id","listener_ip"],"type":"object","properties":{"conditional_forwarders":{"items":{"$ref":"#/definitions/ConditionalForwarderZone"},"type":"array","description":"The conditional zone forwarders. During matching a zone forwarder,\nthe DNS forwarder will use the conditional fowarder with the longest\ndomain name that matches the query.\n","maxItems":5,"title":"Conditional zone forwarders"},"logical_router_id":{"type":"string","description":"Specify the LogicalRouter where the DnsForwarder runs. The HA mode\nof the hosting LogicalRouter must be Active/Standby.\n","title":"Logical router id"},"cache_size":{"description":"One DNS answer cache entry will consume ~120 bytes. Hence 1 KB cache\nsize can cache ~8 DNS answer entries, and the default 1024 KB cache\nsize can hold ~8k DNS answer entries.\n","title":"Cache size in KB","default":1024,"format":"int32","maximum":16777216,"minimum":1,"type":"integer"},"default_forwarder":{"$ref":"#/definitions/ForwarderZone"},"log_level":{"default":"INFO","enum":["DEBUG","INFO","WARNING","ERROR","FATAL"],"type":"string","description":"Log level of the DNS forwarder","title":"Log level of the DNS forwarder"},"enabled":{"default":true,"type":"boolean","description":"Flag to enable/disable the forwarder","title":"Flag to enable/disable the forwarder"},"listener_ip":{"description":"The ip address the DNS forwarder listens on. It can be an ip address\nalready owned by the logical-router uplink port or router-link, or a\nloopback port ip address. But it can not be a downlink port address.\nUser needs to ensure the address is reachable via router or NAT from\nboth client VMs and upstream servers. User will need to create Firewall\nrules if needed to allow such traffic on a Tier-1 or Tier-0.\n","format":"ipv4","type":"string"}}}]},"LbHttpRequestHeaderDeleteAction":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/LbRuleAction"},{"required":["header_name"],"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"header_name":{"type":"string","description":"Name of a header field of HTTP request message","title":"Name of a header field of HTTP request message"}}}],"description":"This action is used to delete header fields of HTTP request messages at\nHTTP_REQUEST_REWRITE phase. One action can be used to delete all headers\nwith same header name. To delete headers with different header names,\nmultiple actions must be defined.\n","title":"Action to delete HTTP request header fields"},"LicensesListResult":{"x-vmw-nsx-module":"License","description":"Licenses queries result","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"License","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/License"},"readOnly":true,"type":"array","description":"Licenses Results","title":"Licenses Results"}}}]},"NSGroupTagExpression":{"x-vmw-nsx-module":"NSGroup","allOf":[{"$ref":"#/definitions/NSGroupExpression"},{"required":["target_type"],"x-vmw-nsx-module":"NSGroup","type":"object","properties":{"tag_op":{"default":"EQUALS","enum":["EQUALS","CONTAINS","STARTSWITH","ENDSWITH"],"type":"string","description":"Target_type VirtualMachine supports all specified operators for\ntag expression while LogicalSwitch and LogicalPort supports only\nEQUALS operator.\nAll operators perform a case insensitive match.\n","title":"Operator of the tag expression eg- tag.tag = \"Production\""},"scope":{"maxLength":128,"type":"string","description":"The tag.scope attribute of the object","title":"The tag.scope attribute of the object"},"scope_op":{"default":"EQUALS","enum":["EQUALS"],"type":"string","description":"Operator of the scope expression eg- tag.scope = \"S1\".","title":"Operator of the scope expression eg- tag.scope = \"S1\"."},"tag":{"maxLength":256,"type":"string","description":"The tag.tag attribute of the object","title":"The tag.tag attribute of the object"},"target_type":{"enum":["LogicalSwitch","LogicalPort","VirtualMachine","IPSet"],"type":"string","description":"Type of the resource on which this expression is evaluated","title":"Type of the resource on which this expression is evaluated"}}}],"description":"Includes both scope and tag attribute of Tag. The scope and tag expressions\nare logically 'AND' with each other.\neg- tag.scope = \"S1\" AND tag.tag = 'T1'\n","title":"TAG expressions to represent NSGroup membership"},"ClusterProfile":{"x-vmw-nsx-module":"ClusterProfile","allOf":[{"$ref":"#/definitions/ManagedResource"},{"discriminator":"resource_type","x-vmw-nsx-module":"ClusterProfile","required":["resource_type"],"type":"object","properties":{"resource_type":{"description":"Supported cluster profiles.","enum":["EdgeHighAvailabilityProfile","BridgeHighAvailabilityClusterProfile"],"type":"string"}}}]},"AddControllerNodeSpec":{"x-vmw-nsx-module":"ClusterManagement","required":["mpa_msg_client_info","host_msg_client_info","type"],"type":"object","properties":{"mpa_msg_client_info":{"$ref":"#/definitions/MsgClientInfo"},"host_msg_client_info":{"$ref":"#/definitions/MsgClientInfo"},"clustering_params":{"$ref":"#/definitions/ClusteringInfo"},"node_id":{"type":"string","description":"Only use this if an id for the node already exists with MP. If not specified, then the node_id will be set to a random id.","title":"Internal identifier of the node"},"control_plane_server_certificate":{"type":"string","description":"Deprecated. Do not supply a value for this property.","x-deprecated":true},"type":{"readOnly":false,"enum":["AddControllerNodeSpec"],"type":"string","description":"must be set to AddControllerNodeSpec","title":"must be set to AddControllerNodeSpec"}}},"TnNodeStackSpanStatus":{"description":"List all the TNs spaned in L3PortMirrorSession mirror stack health status.\n","title":"List all L3PortMirrorSession TN nodes mirror stack health status","required":["tn_node_name","dedicated_stack_status","vmknic_status","detail","last_updated_time"],"x-vmw-nsx-module":"PortMirroring","type":"object","properties":{"tn_node_name":{"type":"string","description":"For L3PortMirrorSession configured mirror stack, show the TN node friendly\nname which spaned in L3PortMirrorSession.\n","title":"TN node name that configured L3SPAN mirror stack"},"vmknic_status":{"description":"Show the vmknic health status, if the vmknic has been bouned to mirror\nstack, it will show SUCCESS or it will show FAILED.\n","enum":["UNKNOWN","SUCCESS","FAILED"],"type":"string"},"dedicated_stack_status":{"description":"Show the dedicated mirror stack health status, if the TN node has the mirror\nstack, it will show SUCCESS or it will show FAILED.\n","enum":["UNKNOWN","SUCCESS","FAILED"],"type":"string"},"tn_node_id":{"type":"string","description":"For L3PortMirrorSession configured mirror stack, show the TN node UUID\nwhich spaned in L3PortMirrorSession.\n","title":"TN node ID that configured L3PortMirrorSession mirror stack"},"detail":{"type":"string","description":"Give the detail info for mirror stack and vmknic health status.\nIf the stack or vmknic is FAILED, detail info will tell user reason\nwhy the stauts is FAILED. So that user can correct their configuration.\n","title":"give detail info and reason about the vmknic and statck status"},"last_updated_time":{"type":"integer","description":"TN miror stack status will be updated periodically, this item\nindicates the lastest timestamp of TN node stack status is updated.\n","format":"int64"}}},"InterfaceNeighborPropertyListResult":{"x-vmw-nsx-module":"Lldp","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"Lldp","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/InterfaceNeighborProperties"},"type":"array","description":"Interface neighbor property results","title":"Interface neighbor property results"}}}],"description":"Interface neighbor property query results","title":"Interface neighbor property query results"},"MacPool":{"x-vmw-nsx-module":"MACAM","description":"A collection of ranges of MAC addresses","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"MACAM","required":["ranges"],"type":"object","properties":{"ranges":{"items":{"$ref":"#/definitions/MacRange"},"type":"array","description":"Array of ranges for MAC addresses","title":"Array of ranges for MAC addresses"}}}]},"LbVariableCondition":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/LbRuleCondition"},{"required":["variable_value","variable_name"],"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"variable_value":{"type":"string","description":"Value of variable to be matched","title":"Value of variable to be matched"},"case_sensitive":{"default":true,"type":"boolean","description":"If true, case is significant when comparing variable value.\n","title":"A case sensitive flag for variable value comparing"},"match_type":{"description":"Match type of variable value","default":"REGEX","enum":["STARTS_WITH","ENDS_WITH","EQUALS","CONTAINS","REGEX"],"type":"string"},"variable_name":{"type":"string","description":"Name of the variable to be matched","title":"Name of the variable to be matched"}}}],"description":"This condition is used to match variable's name and value at all\nphases. The variables could be captured from REGEX or assigned by\nLbVariableAssignmentAction or system embedded variable. Varialbe_name\nand variable_value should be matched at the same time.\n","title":"Condition to match IP header fields"},"RouteDetails":{"x-vmw-nsx-module":"AggSvcLogicalRouter","type":"object","description":"BGP route details.","properties":{"med":{"readOnly":true,"format":"int64","type":"integer","description":"BGP Multi Exit Discriminator attribute.","title":"Multi Exit Discriminator"},"next_hop":{"description":"Next hop IP address.","format":"ip","readOnly":true,"type":"string"},"network":{"description":"CIDR network address.","format":"ip-cidr-block","readOnly":true,"type":"string"},"weight":{"readOnly":true,"format":"int64","type":"integer","description":"BGP Weight attribute.","title":"Weight"},"local_pref":{"readOnly":true,"format":"int64","type":"integer","description":"BGP Local Preference attribute.","title":"Local preference"},"as_path":{"readOnly":true,"type":"string","description":"BGP AS path attribute.","title":"AS path"}},"title":"BGP route details"},"TraceflowObservation":{"discriminator":"resource_type","x-vmw-nsx-module":"Traceflow","required":["resource_type"],"type":"object","properties":{"timestamp_micro":{"readOnly":true,"format":"int64","type":"integer","description":"Timestamp when the observation was created by the transport node (microseconds epoch)","title":"Timestamp when the observation was created by the transport node"},"component_sub_type":{"description":"The sub type of the component that issued the observation.","enum":["LR_TIER0","LR_TIER1","LR_VRF_TIER0","LS_TRANSIT","SI_CLASSIFIER","SI_PROXY","VDR","ENI","AWS_GATEWAY","TGW_ROUTE","EDGE_UPLINK","DELL_GATEWAY","LGW_ROUTE","UNKNOWN"],"readOnly":true,"type":"string"},"resource_type":{"enum":["TraceflowObservationForwarded","TraceflowObservationDropped","TraceflowObservationDelivered","TraceflowObservationReceived","TraceflowObservationForwardedLogical","TraceflowObservationDroppedLogical","TraceflowObservationReceivedLogical","TraceflowObservationReplicationLogical","TraceflowObservationRelayedLogical"],"type":"string"},"component_type":{"description":"The type of the component that issued the observation.","enum":["PHYSICAL","LR","LS","DFW","BRIDGE","EDGE_TUNNEL","EDGE_HOSTSWITCH","FW_BRIDGE","EDGE_RTEP_TUNNEL","LOAD_BALANCER","NAT","IPSEC","SERVICE_INSERTION","VMC","SPOOFGUARD","EDGE_FW","DLB","ANTREA_SPOOFGUARD","ANTREA_LB","ANTREA_ROUTING","ANTREA_DFW","ANTREA_FORWARDING","HOST_SWITCH","UNKNOWN"],"readOnly":true,"type":"string"},"transport_node_name":{"readOnly":true,"type":"string","description":"name of the transport node that observed a traceflow packet","title":"name of the transport node that observed a traceflow packet"},"timestamp":{"description":"Timestamp when the observation was created by the transport node (milliseconds epoch)","format":"int64","readOnly":true,"type":"integer"},"transport_node_id":{"readOnly":true,"type":"string","description":"id of the transport node that observed a traceflow packet","title":"id of the transport node that observed a traceflow packet"},"sequence_no":{"readOnly":true,"format":"int64","type":"integer","description":"the hop count for observations on the transport node that a traceflow packet is injected in will be 0. The hop count is incremented each time a subsequent transport node receives the traceflow packet. The sequence number of 999 indicates that the hop count could not be determined for the containing observation.","title":"the sequence number is the traceflow observation hop count"},"transport_node_type":{"description":"type of the transport node that observed a traceflow packet","enum":["ESX","RHELKVM","UBUNTUKVM","CENTOSKVM","RHELCONTAINER","CENTOSCONTAINER","RHELSERVER","UBUNTUSERVER","CENTOSSERVER","SLESKVM","SLESSERVER","WINDOWSSERVER","RHELSMARTNIC","OELSERVER","UBUNTUSMARTNIC","EDGE","PUBLIC_CLOUD_GATEWAY_NODE","OTHERS","HYPERV"],"readOnly":true,"type":"string"},"component_name":{"readOnly":true,"type":"string","description":"The name of the component that issued the observation.","title":"The name of the component that issued the observation."}}},"DnsFailedQueries":{"x-vmw-nsx-module":"DnsForwarder","type":"object","description":"The array of the failed DNS queries with entry count and timestamp\non active and standby transport node.\n","properties":{"timestamp":{"readOnly":true,"type":"string","description":"Timestamp of the request, in YYYY-MM-DD HH:MM:SS.zzz format.\n","title":"Timestamp of the request"},"per_node_failed_queries":{"items":{"$ref":"#/definitions/PerNodeDnsFailedQueries"},"readOnly":true,"type":"array","description":"The array of failed DNS queries on active and standby transport node.\nIf there is no standby node, the failed queries on standby node will\nnot be present.\n","title":"The array of failed DNS queries on active and standby transport node"}},"title":"The array of failed DNS queries for active and standby transport node"},"DhcpV6InfoBase":{"x-vmw-nsx-module":"Dhcp","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"Dhcp","type":"object","properties":{"lease_time":{"description":"Lease time, in seconds.","title":"Lease time","default":86400,"format":"int64","maximum":4294967295,"minimum":60,"type":"integer"},"sntp_servers":{"description":"SNTP server ips.","title":"SNTP server ips","minItems":0,"items":{"description":"IPv6 address","format":"ipv6","type":"string"},"maxItems":2,"type":"array"},"preferred_time":{"description":"Preferred time, in seconds. If this value is not provided, the value\nof lease_time*0.8 will be used.\n","format":"int64","title":"Preferred time","maximum":4294967295,"minimum":48,"type":"integer"},"dns_nameservers":{"description":"Primary and secondary DNS server address to assign host. They can be\noverridden by ip-pool or static-binding level property.\n","title":"DNS ips","minItems":0,"items":{"description":"IPv6 address","format":"ipv6","type":"string"},"maxItems":2,"type":"array"},"domain_names":{"items":{"type":"string"},"type":"array","description":"Host name or prefix to be assigned to host. It can be overridden by\nip-pool or static-binding level property.\n","title":"Domain name"}}}],"description":"Base type of IPv6 ip-allocation extended by ip-pool and static-binding.\n","title":"Base type of IPv6 ip-allocation"},"MacAddressListResult":{"x-vmw-nsx-module":"AggSvcLogicalSwitch","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"AggSvcLogicalSwitch","type":"object","properties":{"last_update_timestamp":{"description":"Timestamp when the data was last updated; unset if data source has never updated the data.","format":"int64","readOnly":true,"type":"integer"},"logical_switch_id":{"readOnly":true,"type":"string","description":"The id of the logical Switch","title":"The id of the logical Switch"},"results":{"items":{"$ref":"#/definitions/MacTableEntry"},"type":"array"},"transport_node_id":{"readOnly":true,"type":"string","description":"Transport node identifier","title":"Transport node identifier"}}}]},"AllocationRule":{"description":"Allocation rule on edge cluster which will be considered in auto placement\nof TIER1 logical routers, DHCP and MDProxy.\n","title":"Allocation rule on edge cluster","required":["action"],"x-vmw-nsx-module":"EdgeClusters","type":"object","properties":{"action":{"$ref":"#/definitions/AllocationRuleAction"}}},"EdgeTransportNodeMemoryUsage":{"x-vmw-nsx-module":"ApplianceStats","type":"object","description":"Point in time usage of system, datapath, swap and cache memory in edge node.","properties":{"cache_usage":{"readOnly":true,"type":"number","description":"Percentage of RAM on the system that can be flushed out to disk.","title":"Percentage of RAM on the system that can be flushed out to disk"},"swap_usage":{"readOnly":true,"type":"number","description":"Percentage of swap disk in use.","title":"Percentage of swap disk in use"},"system_mem_usage":{"readOnly":true,"type":"number","description":"Percentage of RAM in use on edge node.","title":"Percentage of RAM in use on edge node"},"datapath_total_usage":{"readOnly":true,"type":"number","description":"Percentage of memory in use by datapath processes which includes RES and hugepage memory.","title":"Percentage of memory in use by datapath processes"},"datapath_mem_usage_details":{"$ref":"#/definitions/EdgeTransportNodeDatapathMemoryUsage"}},"title":"Memory usage details of edge node"},"ApplianceLatencyListResult":{"x-vmw-nsx-module":"ShaApplianceMonitor","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["result_count"],"x-vmw-nsx-module":"ShaApplianceMonitor","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/ApplianceLatencyData"},"type":"array","description":"Display the appliance latency data list.","title":"Appliance Process List"},"result_count":{"format":"int64","type":"integer","description":"Total appliance latency count","title":"Total appliance latency count"}}}],"description":"List of process data","title":"List of process data"},"IPSubnet":{"x-vmw-nsx-module":"LogicalRouterPorts","required":["ip_addresses","prefix_length"],"type":"object","properties":{"ip_addresses":{"description":"All IP addresses, some of which may be automatically\nconfigured. When updating this field, the payload may\ncontain only the IP addresses that should be changed,\nor may contain the IP addresses to change as well as\nthe automatically assigned addresses.\nCurrently, only one updatable address and one\nsystem-maintained address are supported.\nCurrently, the system-maintained address supported is\nExtended Unique Identifier(EUI)-64 address.\nEUI-64 address is generated by the system only when user\nconfigured ip-subnet has prefix length less than\nor equal to 64.\n","title":"IP Addresses","minItems":1,"items":{"description":"IPv4 or IPv6 address","format":"ip","type":"string"},"maxItems":2,"type":"array"},"prefix_length":{"description":"Subnet Prefix Length","format":"int64","title":"Subnet Prefix Length","maximum":128,"minimum":1,"type":"integer"}}},"UpgradeCheckListResults":{"x-vmw-nsx-module":"Upgrade","type":"object","properties":{"failed_checks":{"$ref":"#/definitions/UpgradeCheckListResult"},"checks_with_warnings":{"$ref":"#/definitions/UpgradeCheckListResult"},"successful_checks":{"$ref":"#/definitions/UpgradeCheckListResult"}}},"NodeAsyncReplicatorServiceProperties":{"x-vmw-nsx-module":"MISSING_MODULE","allOf":[{"$ref":"#/definitions/NodeServiceProperties"},{"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"service_properties":{"$ref":"#/definitions/LoggingServiceProperties"}}}],"description":"Node service properties","title":"Node service properties"},"FeaturePermissionListResult":{"x-vmw-nsx-module":"AAA","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"AAA","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/FeaturePermission"},"type":"array","description":"List results","title":"List results"}}}]},"InstanceEndpointListResult":{"x-vmw-nsx-module":"ServiceInsertion","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"ServiceInsertion","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/InstanceEndpoint"},"readOnly":true,"type":"array","description":"List of instance endpoints.","title":"Instance End Point list"}}}],"description":"List of instance endpoints.","title":"Instance Endpoint List"},"ServiceChainMapping":{"x-vmw-nsx-module":"ServiceInsertionCommonTypes","type":"object","description":"A ServiceInsertionServiceProfile can be part of multiple ServiceChains. ServiceChainMapping for a particular profile will contain a list of all the ServiceChains it's part of. Each Mapping will also contain some metadata to uniquely identify a profile from other profiles.","properties":{"service_chain_id":{"readOnly":true,"type":"string","description":"A unique id generated for every ServiceChain. This is not a uuid.","title":"Service Chain id"},"direction":{"readOnly":true,"enum":["FORWARD","REVERSE"],"type":"string","description":"Each ServiceChain has forward_path_service_profiles and reverse_path_service_profiles. This property will indicate which of them being used. FORWARD - forward_path_service_profiles REVERSE - reverse_path_service_profiles","title":"Direction"},"service_index":{"readOnly":true,"format":"int64","type":"integer","description":"Service Index represents a numerical position of a ServiceInsertionServiceProfile in a ServiceChain. It will be in reverse order. Service Index can point to either forward_path_service_profiles or reverse_path_service_profiles indicated by direction property. Example - For a ServiceChain A-B-C, A will have index of 3, B will have index of 2 and C will have index of 1.","title":"Service Index"}},"title":"Service Chain Mapping"},"AggregatedDataCounter":{"x-vmw-nsx-module":"AggSvcL2Types","type":"object","properties":{"tx_bytes":{"$ref":"#/definitions/DataCounter"},"rx_packets":{"$ref":"#/definitions/DataCounter"},"tx_packets":{"$ref":"#/definitions/DataCounter"},"rx_bytes":{"$ref":"#/definitions/DataCounter"}}},"KnownHostParameter":{"x-vmw-nsx-module":"MISSING_MODULE","required":["host"],"type":"object","properties":{"host":{"description":"Known host hostname or IP address","format":"hostname-or-ipv4","type":"string"},"port":{"description":"Known host port","title":"Known host port","default":22,"format":"int64","maximum":65535,"minimum":1,"type":"integer"}}},"NSProfile":{"x-vmw-nsx-module":"NSProfile","allOf":[{"$ref":"#/definitions/ManagedResource"},{"required":["nsprofile_attribute"],"x-vmw-nsx-module":"NSProfile","type":"object","properties":{"nsprofile_attribute":{"items":{"$ref":"#/definitions/NSAttributes"},"type":"array","description":"Reference to the encapsulating object of attributes/sub-attributes for\nNSProfile.\n","title":"NSProfile attributes and sub-attributes object"},"is_valid":{"default":true,"readOnly":true,"type":"boolean","description":"If set to false, the NSProfile has some app ids which\nare unsupported. Those were allowed to be added in\nprevious releases but in testing in later phases\nfound that those app ids could not be detected.\n","title":"Flag indicating if NSProfile has supported app ids"}}}],"description":"An entity that encapsulates attributes and sub-attributes of various\nnetwork services (ex. L7 services,domain name,encryption algorithm)\nThe entity will be consumed in DFW rules and can be added in new\ntuple called profile in DFW rules. This entity is design to be generic\nand can be consumed at other places as well where attributes and\nsub-attributes collection can be used. To get a list of supported\nattributes and sub-attributes fire the following REST API\nGET https://<nsx-mgr>/api/v1/ns-profiles/attributes\n","title":"Network Services Profile entity"},"TransportNodeStateListResult":{"x-vmw-nsx-module":"TransportNode","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"TransportNode","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/TransportNodeState"},"readOnly":true,"type":"array","description":"Transport Node State Results","title":"Transport Node State Results"}}}],"description":"Transport node state queries result","title":"Transport node state queries result"},"IntelligenceClusterNodeVMDeploymentRequest":{"description":"Contains the deployment information for a NSX-Intelligence node VM.\n","title":"Info for NSX-Intelligence node deployment request","required":["deployment_config"],"x-vmw-nsx-module":"NsxIntelligenceDeployment","type":"object","properties":{"deployment_config":{"$ref":"#/definitions/IntelligenceClusterNodeVMDeploymentConfig"},"vm_id":{"readOnly":true,"type":"string","description":"ID of the VM maintained internally.\nNote: This is automatically generated and cannot be modified.\n","title":"ID of VM used to recognize it"},"user_settings":{"$ref":"#/definitions/NodeUserSettings"},"form_factor":{"description":"Specifies the desired \"size\" of the VM\n","default":"SMALL","enum":["EVALUATION","STANDARD","ADVANCED","SMALL","LARGE","EXTRA_LARGE"],"type":"string"}}},"LogicalPortMacAddressCsvListResult":{"x-vmw-nsx-module":"AggSvcLogicalPort","allOf":[{"$ref":"#/definitions/CsvListResult"},{"x-vmw-nsx-module":"AggSvcLogicalPort","type":"object","properties":{"last_update_timestamp":{"description":"Timestamp when the data was last updated; unset if data source has never updated the data.","format":"int64","readOnly":true,"type":"integer"},"results":{"items":{"$ref":"#/definitions/LogicalPortMacTableCsvEntry"},"type":"array"}}}]},"LbActiveMonitor":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/LbMonitor"},{"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"monitor_port":{"description":"If the monitor port is specified, it would override pool member port\nsetting for healthcheck. A port range is not supported.\nFor ICMP monitor, monitor_port is not required.\n","format":"port-or-range","type":"string"},"fall_count":{"description":"num of consecutive checks must fail before marking it down","title":"num of consecutive checks must fail before marking it down","default":3,"format":"int64","maximum":2147483647,"minimum":1,"type":"integer"},"interval":{"description":"the frequency at which the system issues the monitor check (in second)","title":"the frequency at which the system issues the monitor check (in second)","default":5,"format":"int64","maximum":2147483647,"minimum":1,"type":"integer"},"rise_count":{"description":"num of consecutive checks must pass before marking it up","title":"num of consecutive checks must pass before marking it up","default":3,"format":"int64","maximum":2147483647,"minimum":1,"type":"integer"},"timeout":{"description":"the number of seconds the target has in which to respond to the monitor\nrequest\n","title":"the number of seconds the target has in which to respond to the monitor\nrequest\n","default":15,"format":"int64","maximum":2147483647,"minimum":1,"type":"integer"}}}]},"ServiceInstanceListResult":{"x-vmw-nsx-module":"ServiceInsertion","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"ServiceInsertion","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/BaseServiceInstance"},"readOnly":true,"type":"array","description":"List of the Service-Insertion ServicesInstances. The list has to be homogenous.","title":"Service-Instance list"}}}],"description":"Service Instance List","title":"Service Instance List"},"PacketCaptureSessionList":{"x-vmw-nsx-module":"PacketCapture","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"PacketCapture","required":["result_count"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/PacketCaptureSession"},"type":"array","description":"Packet capture list for all sessoins","title":"Packet capture list for all sessoins"},"result_count":{"format":"int64","type":"integer","description":"Total capture session count","title":"Total capture session count"}}}]},"LbJwtAuthAction":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/LbRuleAction"},{"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"tokens":{"items":{"type":"string"},"type":"array","description":"JWT is an open standard that defines a compact and\nself-contained way for securely transmitting information between\nparties as a JSON object. Load balancer will search for every specified\ntokens one by one for the jwt message until found. This parameter is\noptional. In case not found or this field is not configured, load\nbalancer searches the Bearer header by default in the http request\n\"Authorization: Bearer <token>\".\n","title":"JWT tokens"},"pass_jwt_to_pool":{"default":false,"type":"boolean","description":"Specify whether to pass the JWT to backend server or remove it. By\ndefault, it is false which means will not pass the JWT to backend\nservers.\n","title":"Whether to pass the JWT to backend server or remove it"},"realm":{"type":"string","description":"A description of the protected area. If no realm is specified, clients\noften display a formatted hostname instead. The configured realm is\nreturned when client request is rejected with 401 http status. In the\nresponse, it will be \"WWW-Authentication: Bearer realm=<realm>\".\n","title":"JWT realm"},"key":{"$ref":"#/definitions/LbJwtKey"}}}],"description":"This action is used to control access to backend server resources using\nJSON Web Token(JWT) authentication. The JWT authentication is done before\nany HTTP manipulation if the HTTP request matches the given condition in\nLbRule. Any verification failed, the HTTP process will be terminated, and\nHTTP response with 401 status code and WWW-Authentication header will be\nreturned to client.\n","title":"Action to control access using JWT authentication"},"TransportNodeCollectionListResult":{"x-vmw-nsx-module":"TransportNodeCollection","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"TransportNodeCollection","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/TransportNodeCollection"},"readOnly":true,"type":"array","description":"Transport Node collection results","title":"Transport Node collection results"}}}],"description":"Transport Node collections list result","title":"Transport Node collections list result"},"StatsConfiguration":{"x-vmw-nsx-module":"NsxDashboard","allOf":[{"$ref":"#/definitions/WidgetConfiguration"},{"x-vmw-nsx-module":"NsxDashboard","type":"object","properties":{"navigation":{"maxLength":1024,"type":"string","description":"Hyperlink of the specified UI page that provides details.","title":"Navigation to a specified UI page"},"stat":{"$ref":"#/definitions/StatItem"},"sections":{"minItems":0,"items":{"$ref":"#/definitions/DonutSection"},"type":"array","description":"Sections","title":"Sections"},"sub_type":{"enum":["COMPACT"],"type":"string","description":"A sub-type of StatsConfiguration. If sub-type is not specified the parent type is rendered. The COMPACT sub_type, conserves the space for the widget. The statistic is placed on the right side on top of the status bar and the title of the widget is placed on the left side on the top of the status bar. The COMPACT style aligns itself horizontally as per the width of the container. If multiple widgets are placed insided the container then the widgets are placed one below the other to conserve the space.","title":"Sub-type of the StatsConfiguration"},"label":{"$ref":"#/definitions/Label"}}}],"description":"Represents configuration of a statistic for an entity. Example, number of logical switches and their admin states.","title":"Stats Configuration"},"LogicalServiceRouterClusterState":{"x-vmw-nsx-module":"LogicalRouter","allOf":[{"$ref":"#/definitions/EdgeConfigurationState"},{"x-vmw-nsx-module":"LogicalRouter","type":"object"}],"description":"This holds the state of Service Router. If there are errors in\nrealizing SR outside of MP, it gives details of the components and\nspecific errors.\n","title":"Realization State of Service Router."},"ComputeCollectionNetworkInterfacesListResult":{"x-vmw-nsx-module":"InventoryCmObj","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"InventoryCmObj","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/DiscoveredNodeNetworkInterfaces"},"type":"array","description":"List of discovered node with network interfaces","title":"Discovered node network interfaces"}}}],"description":"List of network interfaces for all discovered nodes in compute collection","title":"ComputeCollection Interfaces List Result"},"PortMirroringFilter":{"x-vmw-nsx-module":"PortMirroring","type":"object","properties":{"filter_action":{"default":"MIRROR","enum":["MIRROR","DO_NOT_MIRROR"],"type":"string","description":"If set to MIRROR, packets will be mirrored. If set to DO_NOT_MIRROR, packets will not be mirrored.","title":"Mirror action to filter packets"},"ip_protocol":{"enum":["TCP","UDP"],"type":"string","description":"The transport protocols of TCP or UDP, used to match the transport protocol of a packet. If not provided, no filtering by IP protocols is performed.","title":"The protocol used to filter packets."},"src_ips":{"$ref":"#/definitions/IPAddresses"},"dst_ips":{"$ref":"#/definitions/IPAddresses"},"dst_ports":{"description":"Destination port in the form of a port or port range, used to match the destination port of a packet. If not provided, no filtering by destination port is performed.","format":"port-or-range","type":"string"},"src_ports":{"description":"Source port in the form of a port or port range, used to match the source port of a packet. If not provided, no filtering by source port is performed.","format":"port-or-range","type":"string"}}},"EventListResult":{"x-vmw-nsx-module":"Monitoring","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"Monitoring","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/MonitoringEvent"},"readOnly":true,"type":"array","description":"List of events defined","title":"List of events defined"}}}]},"ClusterNodeVMDeploymentProgressState":{"x-vmw-nsx-module":"NsxIntelligenceDeployment","type":"object","description":"Deployment progress state of node VM. This Object contains name of current deployment step and overall progress percentage.","properties":{"progress":{"readOnly":true,"format":"int64","type":"integer","description":"Overall progress percentage of deployment completed","title":"Progress percentage"},"current_step_title":{"readOnly":true,"type":"string","description":"Name of the current running step of deployment","title":"Name of the current step"}},"title":"Deployment progress of node VM"},"ServiceDeploymentListResult":{"x-vmw-nsx-module":"ServiceInsertionVMDeployment","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"ServiceInsertionVMDeployment","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/ServiceDeployment"},"type":"array","description":"Array of existing ServiceDeployments in database\n","title":"Results"}}}],"description":"Result of List of ServiceDeployments","title":"ServiceDeployment list result"},"L2VPNPerLSTrafficStatistics":{"x-vmw-nsx-module":"L2VPNStatistics","type":"object","description":"Traffic statistics for a logical switch.","properties":{"packets_out":{"readOnly":true,"format":"int64","type":"integer","description":"Total number of outgoing packets.","title":"Packets out"},"packets_receive_error":{"readOnly":true,"format":"int64","type":"integer","description":"Total number of incoming packets dropped.","title":"Packets recieved error"},"bytes_in":{"readOnly":true,"format":"int64","type":"integer","description":"Total number of incoming bytes.","title":"Bytes in"},"bum_packets_in":{"readOnly":true,"format":"int64","type":"integer","description":"Total number of incoming Broadcast, Unknown unicast and Multicast (BUM) packets.","title":"Broadcast, Unknown unicast and Multicast (BUM) packets in"},"bum_bytes_out":{"readOnly":true,"format":"int64","type":"integer","description":"Total number of outgoing Broadcast, Unknown unicast and Multicast (BUM) bytes.","title":"Broadcast, Unknown unicast and Multicast (BUM) bytes out"},"logical_switch":{"$ref":"#/definitions/ResourceReference"},"bytes_out":{"readOnly":true,"format":"int64","type":"integer","description":"Total number of outgoing bytes.","title":"Bytes out"},"packets_sent_error":{"readOnly":true,"format":"int64","type":"integer","description":"Total number of packets dropped while sending for any reason.","title":"Packets sent error"},"bum_packets_out":{"readOnly":true,"format":"int64","type":"integer","description":"Total number of outgoing Broadcast, Unknown unicast and Multicast (BUM) packets.","title":"Broadcast, Unknown unicast and Multicast (BUM) packets out"},"packets_in":{"readOnly":true,"format":"int64","type":"integer","description":"Total number of incoming packets.","title":"Packets in"},"bum_bytes_in":{"readOnly":true,"format":"int64","type":"integer","description":"Total number of incoming Broadcast, Unknown unicast and Multicast (BUM) bytes.","title":"Broadcast, Unknown unicast and Multicast (BUM) bytes in"}},"title":"Traffic statistics per logical switch"},"EdgeTransportNodeDatapathMemoryUsage":{"x-vmw-nsx-module":"ApplianceStats","type":"object","description":"Detailed view of the datapath memory usage. Details out the heap and per memory pool point in time usage.","properties":{"highest_datapath_mem_pool_usage":{"readOnly":true,"type":"number","description":"Highest percentage usage value among datapath memory pools.","title":"Highest percentage usage value among datapath memory pools"},"datapath_mem_pools_usage":{"items":{"$ref":"#/definitions/EdgeTransportNodeDatapathMemoryPoolUsage"},"type":"array"},"datapath_heap_usage":{"readOnly":true,"type":"number","description":"Percentage of heap memory in use.","title":"Percentage of heap memory in use"},"highest_datapath_mem_pool_usage_names":{"items":{"readonly":true,"type":"string","description":"List of datapath memory pool(s) with highest usage.","title":"Datapath memory pool(s) with highest usage"},"type":"array"}},"title":"Detailed view of the datapath memory usage. Details out the heap and per memory pool usage"},"IPSetListResult":{"x-vmw-nsx-module":"IPSet","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"IPSet","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/IPSet"},"type":"array","description":"IPSet list results","title":"IPSet list results"}}}],"description":"Paged collection of IPSets","title":"Paged collection of IPSets"},"ControllerClusterStatus":{"x-vmw-nsx-module":"ClusterManagement","type":"object","properties":{"status":{"readOnly":true,"enum":["NO_CONTROLLERS","UNSTABLE","DEGRADED","STABLE","UNKNOWN"],"type":"string","description":"The current status of the controller cluster","title":"The current status of the controller cluster"}}},"LogicalRouterLinkPortOnTIER0":{"x-vmw-nsx-module":"LogicalRouterPorts","allOf":[{"$ref":"#/definitions/LogicalRouterPort"},{"x-vmw-nsx-module":"LogicalRouterPorts","type":"object","properties":{"subnets":{"items":{"$ref":"#/definitions/IPSubnet"},"readOnly":true,"type":"array","description":"Logical router port subnets","title":"Logical router port subnets"},"linked_logical_router_port_id":{"readOnly":true,"type":"string","description":"Identifier of connected LogicalRouterLinkPortOnTIER1 of TIER1 logical router","title":"Identifier of connected LogicalRouterLinkPortOnTIER1"},"mac_address":{"readOnly":true,"type":"string","description":"MAC address","title":"MAC address"}}}],"description":"This port can be configured only on a TIER0 LogicalRouter.\nCreate an empty port to generate an id.\nUse this id in the linked_logical_router_port_id on\nLogicalRouterLinkPortOnTIER1 on TIER1 logical router.\n","title":"Port to connect the LogicalRouterLinkPortOnTIER1 of TIER1 logical router to"},"LogicalRouterLinkPortOnTIER1":{"x-vmw-nsx-module":"LogicalRouterPorts","allOf":[{"$ref":"#/definitions/LogicalRouterPort"},{"x-vmw-nsx-module":"LogicalRouterPorts","type":"object","properties":{"subnets":{"items":{"$ref":"#/definitions/IPSubnet"},"readOnly":true,"type":"array","description":"Logical router port subnets","title":"Logical router port subnets"},"mac_address":{"readOnly":true,"type":"string","description":"MAC address","title":"MAC address"},"linked_logical_router_port_id":{"$ref":"#/definitions/ResourceReference"},"edge_cluster_member_index":{"items":{"type":"integer","format":"int64"},"type":"array","description":"Please use logical router API to pass edge cluster members indexes manually.\n","x-deprecated":true,"title":"Member index of the edge node on the cluster"}}}],"description":"This port can be configured only on a TIER1 LogicalRouter.\nUse the id of the LogicalRouterLinkPortOnTIER0 from TIER0 logical router to set\nthe linked_logical_router_port_id on the port on TIER1 logical router.\n","title":"Port to connect the TIER1 logical router to TIER0 logical router"},"EdgeClusterMemberAllocationProfile":{"x-vmw-nsx-module":"LogicalRouter","type":"object","properties":{"allocation_pool":{"$ref":"#/definitions/EdgeClusterMemberAllocationPool"},"enable_standby_relocation":{"default":false,"type":"boolean","description":"Flag to enable the auto-relocation of standby service router running\non edge cluster and node associated with the logical router. Only\ndynamically allocated tier1 logical routers are considered for the\nrelocation.\n","title":"Flag to enable standby service router relocation"},"allocation_type":{"readOnly":true,"enum":["MANUAL","AUTO"],"type":"string","description":"Allocation type is used to specify the mode used to allocate the LR.\nThis is populated only for TIER1 logical router and for TIER0 this\nwill be null.\n","title":"Resource allocation type"}}},"TransportNode":{"x-vmw-nsx-module":"TransportNode","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"TransportNode","type":"object","properties":{"host_switch_spec":{"$ref":"#/definitions/HostSwitchSpec"},"node_id":{"readOnly":true,"type":"string","description":"Unique Id of the fabric node","x-deprecated":true,"title":"Unique Id of the fabric node"},"node_deployment_info":{"$ref":"#/definitions/Node"},"maintenance_mode":{"readOnly":true,"enum":["ENABLED","FORCE_ENABLED","DISABLED"],"type":"string","description":"The property is read-only, used for querying result. User could update transport node maintenance mode by UpdateTransportNodeMaintenanceMode call.","title":"transport node maintenance mode desired state"},"failure_domain_id":{"type":"string","description":"Set failure domain of edge transport node which will help in\nauto placement of TIER1 logical routers, DHCP Servers and\nMDProxies, if failure domain based allocation is enabled in\nedge cluster API. It is only supported for edge transport node\nand not for host transport node. In case failure domain is not\nset by user explicitly, it will be always assigned with default\nsystem created failure domain.\n","title":"Id of the failure domain"},"is_overridden":{"readOnly":true,"type":"boolean","description":"This flag is relevant to only those hosts which are part of a\ncompute collection which has transport node profile (TNP)\napplied on it. If you change the transport node configuration\nand it is different than cluster level TNP then this flag will\nbe set to true\n","title":"Indicates if config is different than compute collection."},"remote_tunnel_endpoint":{"$ref":"#/definitions/TransportNodeRemoteTunnelEndpointConfig"}}}],"description":"Transport Node","title":"Transport Node"},"NodeServicePropertiesListResult":{"x-vmw-nsx-module":"MISSING_MODULE","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/NodeServiceProperties"},"type":"array","description":"Node service property results","title":"Node service property results"}}}],"description":"Node service property query results","title":"Node service property query results"},"IntervalSampling":{"x-vmw-nsx-module":"LiveTrace","allOf":[{"$ref":"#/definitions/SamplingArgument"},{"x-vmw-nsx-module":"LiveTrace","required":["sampling_interval"],"type":"object","properties":{"sampling_interval":{"description":"Time interval in ms between two sampling actions.","format":"int64","title":"Time interval in ms between two sampling actions.","maximum":30000,"minimum":1,"type":"integer"}}}]},"IdfwDirGroupUserSessionMapping":{"x-vmw-nsx-module":"IdentityFirewall","type":"object","description":"Identity Firewall NSGorup to user mapping to link DirGroup to user session data.\n","properties":{"user_id":{"readOnly":true,"type":"string","description":"User ID.","title":"User ID"},"dir_group_id":{"readOnly":true,"type":"string","description":"Directory Group ID.","title":"Directory Group ID"}},"title":"Identity Firewall NSGorup to user mapping to link DirGroup to user session data"},"IGMPTypeNSService":{"x-vmw-nsx-module":"Types","allOf":[{"$ref":"#/definitions/NSServiceElement"},{"x-vmw-nsx-module":"Types","type":"object"}],"description":"A NSService that represents IGMP protocol","title":"A NSService that represents IGMP protocol"},"BridgeEndpointProfileListResult":{"x-vmw-nsx-module":"BridgeEndpointProfile","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"BridgeEndpointProfile","type":"object","properties":{"results":{"description":"BridgeEndpointProfile Results","title":"BridgeEndpointProfile Results","minItems":0,"items":{"$ref":"#/definitions/BridgeEndpointProfile"},"readOnly":true,"type":"array"}}}],"description":"Bridge Endpoint Profile queries result","title":"Bridge Endpoint Profile queries result"},"IdsUserList":{"x-vmw-nsx-module":"IDSMetrics","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"IDSMetrics","type":"object","properties":{"results":{"items":{"type":"string"},"readOnly":true,"type":"array","description":"List of all affected users specific to a particular signature.","title":"List of all affected users"}}}],"description":"List of all affected users pertaining to a\nspecific signature.\n","title":"List of affected Users"},"MacAddressCsvListResult":{"x-vmw-nsx-module":"AggSvcLogicalSwitch","allOf":[{"$ref":"#/definitions/CsvListResult"},{"x-vmw-nsx-module":"AggSvcLogicalSwitch","type":"object","properties":{"last_update_timestamp":{"description":"Timestamp when the data was last updated; unset if data source has never updated the data.","format":"int64","readOnly":true,"type":"integer"},"results":{"items":{"$ref":"#/definitions/MacTableCsvRecord"},"type":"array"}}}]},"BridgeEndpointStatistics":{"x-vmw-nsx-module":"AggSvcBridging","allOf":[{"$ref":"#/definitions/AggregatedDataCounter"},{"x-vmw-nsx-module":"AggSvcBridging","type":"object","properties":{"last_update_timestamp":{"description":"Timestamp when the data was last updated; unset if data source has never updated the data.","format":"int64","readOnly":true,"type":"integer"},"endpoint_id":{"readOnly":true,"type":"string","description":"The id of the bridge endpoint","title":"The id of the bridge endpoint"}}}]},"SpacerWidgetConfiguration":{"x-vmw-nsx-module":"NsxDashboard","allOf":[{"$ref":"#/definitions/WidgetConfiguration"},{"x-vmw-nsx-module":"NsxDashboard","type":"object"}],"description":"Represents configuration for spacer widget. For this widget the data source is not applicable. This widget can be use to add the space inside the dashboard container.","title":"Spacer widget Configuration"},"ClusterInitializationNodeInfo":{"x-vmw-nsx-module":"ClusterManagement","type":"object","description":"The type provides the information of a non-running cluster node required for the initialization of a management cluster. The administrator needs to start this node for management cluster to initialize properly (or decommission it explicitly).","properties":{"disk_store_id":{"readOnly":true,"type":"string","description":"The (internal) disk-store ID of the member","title":"The (internal) disk-store ID of the member"},"host_address":{"readOnly":true,"type":"string","description":"The IP address (or domain name) of the cluster node","title":"The IP address (or domain name) of the cluster node"}}},"ServiceAssociationListResult":{"x-vmw-nsx-module":"GroupingObjectsProviders","allOf":[{"$ref":"#/definitions/ListResult"},{"discriminator":"service_type","x-vmw-nsx-module":"GroupingObjectsProviders","required":["service_type"],"type":"object","properties":{"service_type":{"enum":["FireWallServiceAssociationListResult","IpfixServiceAssociationListResult"],"type":"string"}}}]},"RoutesPerTransportNode":{"x-vmw-nsx-module":"AggSvcLogicalRouter","type":"object","description":"BGP routes per transport node.","properties":{"routes":{"items":{"$ref":"#/definitions/RouteDetails"},"readOnly":true,"type":"array","description":"Array of BGP neighbor route details for this transport node.\n","title":"BGP neighbor route details"},"source_address":{"description":"BGP neighbor source address.","format":"ip","readOnly":true,"type":"string"},"transport_node_id":{"readOnly":true,"type":"string","description":"Transport node id","title":"Transport node id"}},"title":"Routes per transport node"},"SwitchingToVmcModeParameters":{"x-vmw-nsx-module":"ApplianceModes","allOf":[{"$ref":"#/definitions/NodeMode"},{"x-vmw-nsx-module":"ApplianceModes","type":"object","properties":{"ea_org":{"$ref":"#/definitions/OrgInfo"},"sre_org":{"$ref":"#/definitions/OrgInfo"},"gss_org":{"$ref":"#/definitions/OrgInfo"},"csp_logout_uri":{"type":"string","description":"This CSP end-point returns the identity provider's logout url. In order to logout, an explicit redirect to this url is needed.","title":"CSP endpoint that returns the identity provider's logout url"},"auth_code":{"$ref":"#/definitions/Oauth2Credentials"},"csp_time_drift":{"format":"int64","type":"integer","description":"CSP time drift in milliseconds","title":"CSP time drift"},"basic_auth_whitelist_ips":{"items":{"type":"string"},"type":"array","description":"List of whitelist IPs for basic auth","title":"Whitelist IPs"},"sddc_id":{"type":"string","description":"SDDC id","title":"SDDC id"},"proxy_port":{"description":"Port of PoP (Point-of-Presence) Http proxy server","format":"int64","title":"Port of PoP (Point-of-Presence) Http proxy server","maximum":65535,"minimum":1,"type":"integer"},"resource_type":{"default":"SwitchingToVmcModeParameters","enum":["SwitchingToVmcModeParameters"],"type":"string","description":"Node Mode type","title":"Node Mode type"},"csp_org_uri":{"type":"string","description":"Relative path on CSP server to the Org location. Can be \"/csp/gateway/am/api/orgs/\".","title":"Relative path to CSP Org"},"default_org_id":{"type":"string","description":"Org ID of a Client - commonly UUID.","title":"Org ID of a Client"},"proxy_host":{"description":"IP/host of PoP (Point-of-Presence) HTTP proxy server","format":"hostname-or-ipv4","type":"string"},"public_client_info":{"$ref":"#/definitions/PublicClientInfo"},"base_url":{"type":"string","description":"Protocol and domain name (or IP address) of a CSP server, like \"https://console-stg.cloud.vmware.com\".","title":"CSP base URL"},"csp_public_key_uri":{"type":"string","description":"CSP endpoint that returns a list of public keys in jwks format. These keys are used in an application to validate that the access-token is valid.","title":"CSP endpoint to get the list of public keys in JWKS format"},"csp_client_credential":{"$ref":"#/definitions/Oauth2Credentials"},"csp_user_authorization_uri":{"type":"string","description":"This endpoint is used with browser redirection only. It discovers the user's Identity Provider (IdP) and sends the user to the IdP login page. It is the starting point of the OAuth 2.0 flow to authenticate end users from an application.","title":"CSP Discovery login entry point for OAuth 2.0 authorization"},"mode_change_only":{"type":"boolean","description":"When this parameter is set to true, only a change of the node mode happens without any update to the auth properties. When this param is not set to true i.e. set to false or not provided, mode change and update to the auth properties will both happen.","title":"Only change node mode"},"csp_client_incoming_credentials":{"items":{"type":"string"},"type":"array","description":"List of incoming client IDs","title":"CSP client incoming credentials"},"service_definition_id":{"type":"string","description":"Service definition id","title":"Service definition id"},"csp_access_token_uri":{"type":"string","description":"This CSP end-point exchanges one of the following grants - authorization_code, refresh_token, client_credentials or client_delegate for an access token.","title":"CSP endpoint that exchanges a grant for an access token"},"csp_user_info_uri":{"type":"string","description":"This endpoint returns the content of the given access token if the token is valid. It also includes the group_ids and group_names if the client is registered with group_id, group_names scopes. It's usually /am/api/userinfo.","title":"CSP user info endpoint"}}}],"description":"Possible values of a mode in a \"/config/nsx_appliance_mode\" file","title":"Parameters required to switch to VMC nsx node mode"},"VsphereDeploymentConfig":{"x-vmw-nsx-module":"FabricNode","description":"The Vsphere deployment configuration determines where to deploy the edge\nnode. It contains settings that are applied during install time.\nUse EdgeNodeSettings to specify host name, SSH, NTP and DNS settings for\nboth deployment and consequent update. These settings are editable for\nmanually deployed edge nodes as well.\nEdgeNodeSettings reports current values configured on the edge node.\n","allOf":[{"$ref":"#/definitions/DeploymentConfig"},{"x-vmw-nsx-module":"FabricNode","required":["data_network_ids","storage_id","management_network_id","vc_id","compute_id"],"type":"object","properties":{"data_network_ids":{"description":"List of distributed portgroups, VLAN logical switch identifiers or segment\npaths to which the datapath serving vnics of edge node vm will be connected.\nIf a VM network interface is not configured, it is disconnected and\nrepresented as an empty string. Edge node supports three datapath vnics\nonly; other values are for internal use.\n","title":"List of portgroups, logical switch identifiers or segment paths for datapath connectivity.","minItems":1,"items":{"type":"string"},"maxItems":4,"type":"array"},"resource_allocation":{"$ref":"#/definitions/ResourceAssignment"},"compute_folder_id":{"type":"string","description":"The edge node vm will be deployed on the specified compute folder created in a datacenter,\nif compute folder is specified.\nNote - User must ensure that compute folder is accessible by specified cluster/host.\n","title":"Compute folder identifier in the specified vcenter server."},"management_network_id":{"type":"string","description":"Distributed portgroup identifier to which the management vnic of edge node vm\nwill be connected. This portgroup must have connectivity with MP and CCP. A\nVLAN logical switch identifier may also be specified.\nIf VM network interface is not connected, it is represented as an empty string.\n","title":"Portgroup, logical switch identifier or segment path for management network connectivity."},"compute_id":{"type":"string","description":"The edge node vm will be deployed on the specified cluster or resourcepool.\nNote - all the hosts must have nsx fabric prepared in the specified cluster.\n","title":"Cluster identifier or resourcepool identifier for specified vcenter server."},"reservation_info":{"$ref":"#/definitions/ReservationInfo"},"vc_id":{"type":"string","description":"The vc specific identifiers will be resolved on this VC.\nSo all other identifiers specified here must belong to this vcenter server.\n","title":"Vsphere compute identifier for identifying the vcenter server."},"storage_id":{"type":"string","description":"The edge node vm will be deployed on the specified datastore. User must ensure\nthat storage is accessible by the specified cluster/host.\n","title":"Storage/datastore identifier in the specified vcenter server."},"default_gateway_addresses":{"description":"The default gateway for edge node must be specified if all the nodes it\ncommunicates with are not in the same subnet.\nNote: Only single IPv4 default gateway address is supported and it must\nbelong to management network.\n","title":"Default gateway for the node.","minItems":1,"items":{"description":"IPv4 or IPv6 address","format":"ip","type":"string"},"maxItems":1,"type":"array"},"management_port_subnets":{"description":"IP Address and subnet configuration for the management port. Note:\nonly one IPv4 address is supported for the management port.\n","title":"Port subnets for management port. Only one IPv4 Address is supported.","minItems":1,"items":{"$ref":"#/definitions/IPSubnet"},"maxItems":1,"type":"array"},"host_id":{"type":"string","description":"The edge node vm will be deployed on the specified Host within the cluster\nif host_id is specified.\nNote - User must ensure that storage and specified networks are accessible by this host.\n","title":"Host identifier in the specified vcenter server."},"advanced_configuration":{"description":"This field is deprecated. EdgeNodeSettings field 'advanced_configuration'\nmust be used instead. Array of additional specific properties for\nadvanced or cloud-specific deployments in key-value format.\n","title":"Advanced configuration","items":{"$ref":"#/definitions/KeyValuePair"},"x-deprecated":true,"readOnly":false,"type":"array"}}}]},"LogicalRouterRouteCsvRecord":{"x-vmw-nsx-module":"AggSvcLogicalRouter","allOf":[{"$ref":"#/definitions/CsvRecord"},{"x-vmw-nsx-module":"AggSvcLogicalRouter","required":["route_type","network"],"type":"object","properties":{"lr_component_id":{"type":"string","description":"Logical router component(Service Router/Distributed Router) id","title":"Logical router component(Service Router/Distributed Router) id"},"next_hop":{"description":"The IP of the next hop","format":"ip","type":"string"},"lr_component_type":{"type":"string","description":"Logical router component(Service Router/Distributed Router) type","title":"Logical router component(Service Router/Distributed Router) type"},"network":{"description":"CIDR network address","format":"ip-cidr-block","type":"string"},"route_type":{"type":"string","description":"Route type (USER, CONNECTED, NSX_INTERNAL,..)","title":"Route type (USER, CONNECTED, NSX_INTERNAL,..)"},"logical_router_port_id":{"type":"string","description":"The id of the logical router port which is used as the next hop","title":"The id of the logical router port which is used as the next hop"},"admin_distance":{"format":"int64","type":"integer","description":"The admin distance of the next hop","title":"The admin distance of the next hop"}}}]},"Dscp":{"x-vmw-nsx-module":"QosSwitchingProfile","type":"object","description":"Dscp value is ignored in case of 'TRUSTED' DscpMode.","properties":{"priority":{"description":"Internal Forwarding Priority","title":"Internal Forwarding Priority","default":0,"format":"int32","maximum":63,"minimum":0,"type":"integer"},"mode":{"description":"Trust settings","enum":["TRUSTED","UNTRUSTED"],"type":"string"}},"title":"One of Quality-of-Service or Encapsulated-Remote-Switched-Port-Analyzer"},"DirectoryGroup":{"x-vmw-nsx-module":"DirectoryService","allOf":[{"$ref":"#/definitions/ManagedResource"},{"discriminator":"resource_type","x-vmw-nsx-module":"DirectoryService","required":["distinguished_name","domain_id","resource_type","domain_name"],"type":"object","properties":{"domain_sync_node_id":{"type":"string","description":"Domain sync node under which this directory group is located. We currently sync only from Root node and hence this attribute doesn't have a specific value set.","title":"Domain synchronization root node id"},"distinguished_name":{"type":"string","description":"Directory group distinguished name","title":"Directory group distinguished name"},"domain_id":{"type":"string","description":"Domain ID this directory group belongs to.","title":"Domain id"},"resource_type":{"type":"string","description":"Directory group resource type comes from multiple sub-classes extending this base class. For example, DirectoryAdGroup is one accepted resource_type. If there are more sub-classes defined, they will also be accepted resource_type.","title":"Directory group resource type for this domain"},"domain_name":{"type":"string","description":"Each active directory domain has a domain naming context (NC), which contains domain-specific data. The root of this naming context is represented by a domain's distinguished name (DN) and is typically referred to as the NC head.","title":"Directory domain distinguished name"}}}]},"SiteStatus":{"x-vmw-nsx-module":"SiteManagerModule","required":["site_name"],"type":"object","properties":{"stubs":{"items":{"$ref":"#/definitions/StubStatus"},"type":"array","description":"Connection status","title":"Connection status"},"site_name":{"type":"string","description":"Site name","title":"Site name"}}},"BaseServiceInstance":{"x-vmw-nsx-module":"ServiceInsertionCommonTypes","allOf":[{"$ref":"#/definitions/ManagedResource"},{"required":["transport_type","resource_type"],"discriminator":"resource_type","x-vmw-nsx-module":"ServiceInsertionCommonTypes","type":"object","properties":{"on_failure_policy":{"enum":["ALLOW","BLOCK"],"type":"string","description":"Failure policy of the service instance - if it has to be different from the service. By default the service instance inherits the FailurePolicy of the service it belongs to.","title":"On Failure Policy"},"transport_type":{"readOnly":false,"enum":["L2_BRIDGE","L3_ROUTED","NSH","NA"],"type":"string","description":"Transport to be used by this service instance for deploying the Service-VM. This field is to be set Not Applicable(NA) if the service only caters to functionality EPP(Endpoint Protection) and MPS.","title":"Transport Type"},"resource_type":{"description":"ServiceInstance is used when NSX handles the lifecyle of\n appliance. Deployment and appliance related all the information is necessary.\nByodServiceInstance is a custom instance to be used when NSX is not handling\n the lifecycles of appliance/s. User will manage their own appliance (BYOD)\n to connect with NSX.\nVirtualServiceInstance is a a custom instance to be used when NSX is not\n handling the lifecycle of an appliance and when the user is not bringing\n their own appliance.\n","enum":["ServiceInstance","ByodServiceInstance","VirtualServiceInstance"],"type":"string"},"service_id":{"readOnly":true,"type":"string","description":"The Service to which the service instance is associated.","title":"Service Id"}}}],"description":"The deployment of a registered service. service instance is instantiation of service.","title":"Base Instance of a service"},"BgpNeighborStatusLiteDto":{"x-vmw-nsx-module":"AggSvcLogicalRouter","type":"object","properties":{"connection_state":{"readOnly":true,"enum":["INVALID","IDLE","CONNECT","ACTIVE","OPEN_SENT","OPEN_CONFIRM","ESTABLISHED","UNKNOWN"],"type":"string","description":"Current state of the BGP session.","title":"BGP session state"},"remote_site":{"$ref":"#/definitions/ResourceReference"},"source_address":{"description":"Source Ip address.","format":"ip","readOnly":true,"type":"string"},"neighbor_address":{"description":"Ip address of BGP neighbor.","format":"ip","readOnly":true,"type":"string"}}},"GuestInfo":{"x-vmw-nsx-module":"Inventory","type":"object","description":"Guest virtual machine details include OS name and computer name of guest VM.\n","properties":{"os_name":{"readOnly":true,"type":"string","description":"OS name of guest virtual machine. Currently this is supported for guests\non ESXi that have VMware Tools installed.\n","title":"OS name"},"computer_name":{"readOnly":true,"type":"string","description":"Computer name of guest virtual machine, which is set inside guest OS.\nCurrently this is supported for guests on ESXi that have VMware Tools installed.\n","title":"Computer name"}},"title":"Guest virtual machine details"},"MigrationFeedbackResponse":{"description":"Detailed feedback requests from the migration tool where user input is required.","title":"Feedback details required for Migration","required":["action","id"],"x-vmw-nsx-module":"Migration","type":"object","properties":{"action":{"readOnly":false,"type":"string","description":"Action selected in response to the feedback request.","title":"Action selected for feedback request"},"values":{"items":{"type":"string"},"readOnly":false,"type":"array","description":"User input provided in the form of a list of values in response to the feedback request.","title":"User input with multiple values for the feedback query"},"id":{"readOnly":false,"type":"string","description":"Identifier of the feedback request.","title":"UUID of the feedback request"},"value":{"readOnly":false,"type":"string","description":"User input provided in response to the feedback request.","title":"User input for the feedback query"}}},"JoinClusterParameters":{"description":"To join a new node to the NSX cluster, issue a JoinCluster API on the new node. The JoinCluster API takes this object as a parameter. Provide the ID of the NSX cluster you want the new node to join and the IP address of one of the nodes already in that cluster. The Cluster Boot Manager running on the new node will then add the new node to the NSX cluster by making a AttachClusterNode REST API call on the node that is already part of the cluster. In order to make a REST API call to the node in the cluster, the Cluster Boot Manager will need username and password of a priviledged user on the node in the cluster. In place of a username and password, Cluster Boot Manager could also use a OAuth token provided. The Cluster Boot Manager needs either the username and password or the OAuth token to make the REST call but not both.","title":"Parameters needed for this node to join the NSX cluster","required":["certficate_sha256_thumbprint","ip_address","cluster_id"],"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"username":{"type":"string","description":"Username on the cluster node","title":"Username on the cluster node"},"certficate_sha256_thumbprint":{"type":"string","description":"SHA256 Thumbprint of the API certificate of the cluster node","title":"SHA256 Thumbprint of the API certificate of the cluster node"},"token":{"type":"string","description":"Limited time OAuth token instead of the username/password","title":"Limited time OAuth token instead of the username/password"},"cluster_id":{"type":"string","description":"UUID of the cluster to join","title":"UUID of the cluster to join"},"password":{"type":"string","description":"Password of the user on the cluster node","title":"Password of the user on the cluster node"},"ip_address":{"type":"string","description":"IP address of a node already part of the cluster to join","title":"IP address of a node already part of the cluster to join"},"port":{"description":"API port on the cluster node","title":"API port on the cluster node","default":443,"format":"int64","maximum":65535,"minimum":1,"type":"integer"}}},"IpBlockListResult":{"x-vmw-nsx-module":"Ipam","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"Ipam","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/IpBlock"},"type":"array","description":"IP block list results","title":"IP block list results"}}}]},"FirewallSectionListResult":{"x-vmw-nsx-module":"Firewall","allOf":[{"$ref":"#/definitions/DSSectionListResult"},{"x-vmw-nsx-module":"Firewall","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/FirewallSection"},"readOnly":true,"type":"array","description":"List of the firewall sections. The list has to be homogenous.","title":"Section list"}}}]},"UrlAlias":{"description":"Short name or alias of a url. It is used to represent the url.","title":"Url Alias","required":["url"],"x-vmw-nsx-module":"NsxDashboard","type":"object","properties":{"alias":{"maxLength":255,"type":"string","description":"Short name or alias of url, if any. If not specified, the url can be referenced by its index in the array of urls of the datasource instance as $ (for example, $0).","title":"Url Alias Name"},"request_method":{"default":"Get","enum":["Get","Post"],"type":"string","description":"Type of the http method (Get, Post) to be used while invoking the given url through dashboard datasource framework.","title":"Type of http method"},"request_body":{"type":"object","description":"A raw request body in the form json format for a given url. This request body will be submitted along with request while giving a post api call."},"url":{"maxLength":1024,"type":"string","description":"Url to fetch data from.","title":"Url"},"query":{"maxLength":1024,"type":"string","description":"Search query to be applied, if any. If query string is not provided, it will be ignored.","title":"Search query of the search api, if any"},"keystore_info":{"$ref":"#/definitions/KeyStoreInfo"},"request_headers":{"type":"object","description":"A raw request header in the form json format for a given url. This request header will be submitted along with request while giving a api call."}}},"UnidirectionalServicePath":{"x-vmw-nsx-module":"ServiceInsertionCommonTypes","type":"object","description":"Representing either forward or reverse service path for ingress or egress traffic respectively.","properties":{"hops":{"items":{"$ref":"#/definitions/ServicePathHop"},"readOnly":true,"type":"array","description":"List of service path hops that constitutes the forward or reverse service path.","title":"Forward or reverse service path hops"},"in_maintenance_mode":{"readOnly":true,"type":"boolean","description":"Is forward or revserse service path in maintenance mode or not.","title":"Is in maintenance mode"},"host_cross_count":{"readOnly":true,"format":"int64","type":"integer","description":"The number of times the traffic needs to cross hosts for the given forward or reverse service path.","title":"Host crossing count"},"is_active":{"readOnly":true,"type":"boolean","description":"Is forward or revserse service path active or not.","title":"Is active"},"unidir_service_path_id":{"readOnly":true,"format":"int64","type":"integer","description":"Unique identifier of one directional service path.","title":"Unidirectional service path id"}},"title":"Forward or reverse service path"},"RouteMapListResult":{"x-vmw-nsx-module":"Routing","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"Routing","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/RouteMap"},"type":"array","description":"Paginated list of RouteMaps","title":"Paginated list of RouteMaps"}}}]},"ColumnItem":{"description":"Represents a column of the Grid","title":"Grid Column","required":["field","type","label"],"x-vmw-nsx-module":"NsxDashboard","type":"object","properties":{"sort_key":{"maxLength":255,"type":"string","description":"Sorting on column is based on the sort_key. sort_key represents the field in the output data on which sort is requested.","title":"Key for sorting on this column"},"type":{"description":"Data type of the field.","title":"Field data type","default":"String","enum":["String","Number","Date"],"maxLength":255,"type":"string"},"tooltip":{"items":{"$ref":"#/definitions/Tooltip"},"type":"array","description":"Multi-line text to be shown on tooltip while hovering over a cell in the grid.","title":"Multi-line tooltip"},"label":{"$ref":"#/definitions/Label"},"field":{"maxLength":1024,"type":"string","description":"Field from which values of the column will be derived.","title":"Column Field"},"sort_ascending":{"default":true,"type":"boolean","description":"If true, the value of the column are sorted in ascending order. Otherwise, in descending order.","title":"Represents order of sorting the values"},"drilldown_id":{"maxLength":255,"type":"string","description":"Id of drilldown widget, if any. Id should be a valid id of an existing widget.","title":"Id of drilldown widget"},"hidden":{"default":false,"type":"boolean","description":"If set to true, hides the column","title":"Hide the column"},"navigation":{"maxLength":1024,"type":"string","description":"Hyperlink of the specified UI page that provides details. If drilldown_id is provided, then navigation cannot be used.","title":"Navigation to a specified UI page"},"column_identifier":{"type":"string","description":"Identifies the column and used for fetching content upon an user click or drilldown. If column identifier is not provided, the column's data will not participate in searches and drilldowns.","title":"Identifier for this column"},"render_configuration":{"items":{"$ref":"#/definitions/RenderConfiguration"},"type":"array","description":"Render configuration to be applied, if any.","title":"Render Configuration"}}},"NodeProcessPropertiesListResult":{"x-vmw-nsx-module":"MISSING_MODULE","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/NodeProcessProperties"},"type":"array","description":"Node process property results","title":"Node process property results"}}}],"description":"Node process property query results","title":"Node process property query results"},"FailureDomainListResult":{"x-vmw-nsx-module":"FailureDomain","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"FailureDomain","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/FailureDomain"},"type":"array","description":"Array of all failure domains including system generated default\nfailure domain\n","title":"Failure Domain Results"}}}],"description":"It will have list of failure domains which also includes system generated\nfailure domain.\n","title":"Failure Domain queries result"},"CipherSuite":{"description":"TLS cipher suite","title":"TLS cipher suite","required":["enabled","name"],"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"enabled":{"type":"boolean","description":"Enable status for this cipher suite","title":"Enable status for this cipher suite"},"name":{"type":"string","description":"Name of the TLS cipher suite","title":"Name of the TLS cipher suite"}}},"MessagingClientInfo":{"x-vmw-nsx-module":"ClusterManagement","type":"object","properties":{"client_type":{"enum":["MPA","HOST"],"type":"string","description":"Type of messaging client","title":"Type of messaging client"},"account_name":{"type":"string","description":"Account name in messaging client","title":"Account name in messaging client"}}},"NodeNetworkProperties":{"x-vmw-nsx-module":"MISSING_MODULE","allOf":[{"$ref":"#/definitions/Resource"},{"x-vmw-nsx-module":"MISSING_MODULE","type":"object"}],"description":"Network configuration properties","title":"Network configuration properties"},"MigrationFeedbackRequestListResult":{"x-vmw-nsx-module":"Migration","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"Migration","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/MigrationFeedbackRequest"},"readOnly":false,"type":"array","description":"Paged Collection of feedback requests","title":"Paged Collection of feedback requests"}}}],"description":"List of detailed feedback requests from the migration tool where user input is required.","title":"List of feedback required for Migration"},"LogicalPort":{"x-vmw-nsx-module":"LogicalPort","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"LogicalPort","required":["logical_switch_id","admin_state"],"type":"object","properties":{"logical_switch_id":{"type":"string","description":"Id of the Logical switch that this port belongs to.","title":"Id of the Logical switch that this port belongs to."},"init_state":{"description":"Set initial state when a new logical port is created. 'UNBLOCKED_VLAN'\nmeans new port will be unblocked on traffic in creation, also VLAN will\nbe set with corresponding logical switch setting. This port setting\ncan only be configured at port creation (POST), and cannot be modified.\n'RESTORE_VIF' fetches and restores VIF attachment from ESX host.\n","enum":["UNBLOCKED_VLAN","RESTORE_VIF"],"type":"string"},"switching_profile_ids":{"items":{"$ref":"#/definitions/SwitchingProfileTypeIdEntry"},"type":"array"},"attachment":{"$ref":"#/definitions/LogicalPortAttachment"},"internal_id":{"type":"string","description":"The internal_id of the logical port may or may not be identical to it's\nmanaged resource ID. If a VirtualMachine connected to logical port\nmigrates from one site to another, then on the destination site, it\nwill be connected to different logical port managed resource. However,\nthe internal_id field will be persisted across vmotion.\n","title":"ID of the logical port in Global Manager"},"extra_configs":{"items":{"$ref":"#/definitions/ExtraConfig"},"type":"array","description":"This property could be used for vendor specific configuration in key value\nstring pairs. Logical port setting will override logical switch setting if\nthe same key was set on both logical switch and logical port.\n","title":"Extra configs on logical port"},"ignore_address_bindings":{"description":"IP Discovery module uses various mechanisms to discover address\nbindings being used on each port. If a user would like to ignore\nany specific discovered address bindings or prevent the discovery\nof a particular set of discovered bindings, then those address\nbindings can be provided here. Currently IP range in CIDR format\nis not supported.\n","title":"Address bindings to be ignored by IP Discovery module","minItems":0,"items":{"$ref":"#/definitions/PacketAddressClassifier"},"maxItems":16,"type":"array"},"address_bindings":{"description":"Each address binding must contain both an IPElement and MAC address.\nVLAN ID is optional. This binding configuration can be used by\nfeatures such as spoof-guard and overrides any discovered bindings.\nAny non unique entries are deduplicated to generate a unique set\nof address bindings and then stored. For IP addresses, a subnet\naddress cannot have host bits set. A maximum of 128 unique address\nbindings is allowed per port.\n","title":"Address bindings for logical port","minItems":0,"items":{"$ref":"#/definitions/PacketAddressClassifier"},"maxItems":512,"type":"array"},"origin_id":{"readOnly":true,"type":"string","description":"ID populated by NSX when NSX on DVPG is used to indicate the source distributed virtual port and the corresponding distributed virtual switch. This ID is populated only for logical ports that belong to a logical switch of type DVPG.","title":"ID of the distributed virtual port and the distributed virtual switch in the source vCenter"},"admin_state":{"enum":["UP","DOWN"],"type":"string","description":"Represents Desired state of the logical port","title":"Represents Desired state of the logical port"}}}]},"ClusterProfileTypeIdEntry":{"x-vmw-nsx-module":"ClusterProfile","required":["profile_id"],"type":"object","properties":{"profile_id":{"readOnly":false,"type":"string","description":"key value"},"resource_type":{"description":"Supported cluster profiles.","enum":["EdgeHighAvailabilityProfile","BridgeHighAvailabilityClusterProfile"],"type":"string"}}},"FederationSite":{"description":"Site information.","title":"Site information","required":["is_local","name","active_gm","is_federated","node_type","system_id","site_version","aph_list","id"],"x-vmw-nsx-module":"SiteManagerModule","type":"object","properties":{"is_local":{"type":"boolean","description":"Is site local","title":"Is site local"},"config_version":{"format":"int64","type":"integer","description":"Site config version","title":"Site config version"},"name":{"type":"string","description":"Name of the site","title":"Name of the site"},"active_gm":{"enum":["ACTIVE","STANDBY","NONE","INVALID"],"type":"string","description":"Does site have active GM","title":"Does site have active GM"},"split_brain":{"type":"boolean","description":"Split brain","title":"Split brain"},"is_federated":{"type":"boolean","description":"Is site federated","title":"Is site federated"},"site_version":{"type":"string","description":"Version of the site","title":"Version of the site"},"vip_ip":{"type":"string","description":"Vip ip","title":"Vip ip"},"node_type":{"enum":["GM","LM","GM_AND_LM"],"type":"string","description":"Type of node","title":"Type of node"},"cert_hash":{"type":"string","description":"Hash of the trustManagerCert","title":"Hash of the trustManagerCert"},"cluster_id":{"type":"string","description":"Cluster id","title":"Cluster id"},"trust_manager_cert":{"type":"string","description":"Cert string from trust manager","title":"Cert string from trust manager"},"system_id":{"format":"int64","type":"integer","description":"System id","title":"System id"},"aph_list":{"items":{"$ref":"#/definitions/AphInfo"},"type":"array","description":"Aph services in the site","title":"Aph services in the site"},"id":{"type":"string","description":"Id of the site","title":"Id of the site"}}},"PacketsDroppedBySecurity":{"x-vmw-nsx-module":"AggSvcL2Types","type":"object","properties":{"spoof_guard_dropped":{"items":{"$ref":"#/definitions/PacketTypeAndCounter"},"type":"array","description":"The packets dropped by \"Spoof Guard\"; supported packet types are IPv4, IPv6, ARP, ND, non-IP.","title":"The packets dropped by \"Spoof Guard\"; supported packet types are IPv4, IPv6, ARP, ND, non-IP."},"dhcp_server_dropped_ipv4":{"format":"int64","type":"integer","description":"The number of IPv4 packets dropped by \"DHCP server block\".","title":"The number of IPv4 packets dropped by \"DHCP server block\"."},"dhcp_server_dropped_ipv6":{"format":"int64","type":"integer","description":"The number of IPv6 packets dropped by \"DHCP server block\".","title":"The number of IPv6 packets dropped by \"DHCP server block\"."},"dhcp_client_dropped_ipv4":{"format":"int64","type":"integer","description":"The number of IPv4 packets dropped by \"DHCP client block\".","title":"The number of IPv4 packets dropped by \"DHCP client block\"."},"bpdu_filter_dropped":{"format":"int64","type":"integer","description":"The number of packets dropped by \"BPDU filter\".","title":"The number of packets dropped by \"BPDU filter\"."},"dhcp_client_dropped_ipv6":{"format":"int64","type":"integer","description":"The number of IPv6 packets dropped by \"DHCP client block\".","title":"The number of IPv6 packets dropped by \"DHCP client block\"."}}},"NDRAPrefixConfig":{"x-vmw-nsx-module":"LogicalRouterPorts","required":["network_prefix"],"type":"object","description":"Overrides the router advertisement attributes for the\nIPv6 prefixes.\n","properties":{"network_prefix":{"description":"Override the neighbor discovery prefix preferred time and\nprefix valid time for the subnet on uplink port whose\nnetwork matches with the network address of CIDR specified\nin network_prefix.\n","format":"ipv6-cidr-block","type":"string"},"prefix_valid_time":{"description":"The time interval in seconds, in which the prefix is advertised\nas valid.\n","format":"int64","title":"Subnet Prefix Length","maximum":4294967295,"minimum":0,"type":"integer"},"prefix_preferred_time":{"description":"The time interval in seconds, in which the prefix is advertised\nas preferred.\n","format":"int64","title":"Prefix preferred time","maximum":4294967295,"minimum":0,"type":"integer"}}},"AphInfo":{"description":"APH information.","title":"Apliance proxy hub information","required":["port","node_id","uuid","certificate","address"],"x-vmw-nsx-module":"SiteManagerModule","type":"object","properties":{"port":{"format":"int64","type":"integer","description":"Port of APH service","title":"Port of APH service"},"node_id":{"type":"string","description":"Node ID of the APH service","title":"Node ID of the APH service"},"use_fqdn":{"type":"boolean","description":"whether or not fqdn flag is on","title":"whether or not fqdn flag is on"},"certificate":{"type":"string","description":"PEM Certificate of APH service","title":"PEM Certificate of APH service"},"address":{"type":"string","description":"IP address of APH service","title":"IP address of APH service"},"fqdn":{"type":"string","description":"FQDN, only returned by GET /sites and GET /sites/self","title":"FQDN, only returned by GET /sites and GET /sites/self"},"uuid":{"type":"string","description":"ID of the APH service","title":"ID of the APH service"}}},"X509CrlEntry":{"x-vmw-nsx-module":"CertificateManager","type":"object","description":"Each revoked certificate is identified in a CRL by its certificate serial number.","properties":{"revocation_date":{"readOnly":true,"type":"string","description":"Revocation date."},"serial_number":{"readOnly":true,"type":"string","description":"The revoked certificate's serial number."}},"title":"Each revoked certificate is identified in a CRL by its certificate serial number."},"AppliedTos":{"x-vmw-nsx-module":"UpmCommon","type":"object","description":"Entity lists where the profile will be enabled on.\n","properties":{"logical_ports":{"items":{"$ref":"#/definitions/ResourceReference"},"readOnly":false,"type":"array","description":"Logical Port List","title":"Logical Port List"},"logical_switches":{"items":{"$ref":"#/definitions/ResourceReference"},"readOnly":false,"type":"array","description":"Logical Switch List","title":"Logical Switch List"},"nsgroups":{"items":{"$ref":"#/definitions/ResourceReference"},"readOnly":false,"type":"array","description":"NSGroup List","title":"NSGroup List"}},"title":"Entities Applied to Profile"},"ErrorResolverMetadataList":{"x-vmw-nsx-module":"ErrorResolver","required":["errors"],"type":"object","description":"List of errors with their metadata","properties":{"errors":{"items":{"$ref":"#/definitions/ErrorResolverMetadata"},"type":"array","description":"List of errors with their corresponding metadata.","title":"List of errors with their corresponding metadata."}}},"HeatMapTransportNodesAggregateStatus":{"x-vmw-nsx-module":"Heatmap","type":"object","properties":{"degraded_count":{"format":"int32","type":"integer","description":"Number of transport nodes that are degraded","title":"Number of transport nodes that are degraded"},"down_count":{"format":"int32","type":"integer","description":"Number of transport nodes that are down","title":"Number of transport nodes that are down"},"unknown_count":{"format":"int32","type":"integer","description":"Number of transport nodes with unknown status","title":"Number of transport nodes with unknown status"},"up_count":{"format":"int32","type":"integer","description":"Number of transport nodes that are up","title":"Number of transport nodes that are up"}}},"IntelligenceHostConfigurationInfo":{"x-vmw-nsx-module":"NsxIntelligenceHostConfiguration","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"NsxIntelligenceHostConfiguration","type":"object","properties":{"max_active_flow_count_bm":{"description":"Maximum active network flow to collect in collection interval for Bare Metal server.\n","title":"Maximum active network flow for Bare Metal server","default":12500,"format":"int64","maximum":5000000,"minimum":1,"type":"integer"},"context_data_collection_interval":{"description":"Interval in minute of reporting VM guest context data to NSX-Intelligence.\nRecommend to keep this value the same as flow_data_collection_interval.\n","title":"VM guest context data collection interval","default":5,"format":"int64","maximum":30,"minimum":2,"type":"integer"},"broker_truststore":{"type":"string","description":"A truststore to establish the trust between NSX and NSX-Intelligence brokers.\n","title":"Broker truststore"},"flow_data_collection_interval":{"description":"Interval in minute of reporting network flow data to NSX-Intelligence.\nRecommend to keep this value the same as context_data_collection_interval.\n","title":"Network flow data collection interval","default":5,"format":"int64","maximum":30,"minimum":2,"type":"integer"},"broker_certificate":{"type":"string","description":"A broker certificate to verify the identity of brokers.\n","title":"Broker certificate"},"context_user_sids":{"items":{"type":"string"},"type":"array","description":"List of windows user sid to collect context data.\nEmpty implies all users.\n","title":"List of windows user sid to collect context data"},"enable_context_data_collection":{"default":true,"type":"boolean","description":"Enable NSX-Intelligence context data collection in host nodes.\n","title":"Enable context data collection"},"context_user_uids":{"items":{"type":"string"},"type":"array","description":"List of linux user uid to collect context data.\nEmpty implies all users.\n","title":"List of linux user uid to collect context data"},"enable_flow_data_collection":{"default":true,"type":"boolean","description":"Enable NSX-Intelligence flow data collection in host nodes.\n","title":"Enable flow data collection"},"enable_deep_packet_inspection":{"default":true,"type":"boolean","description":"Enable NSX-Intelligence deep packet inspection in host nodes.\n","title":"Enable deep packet inspection"},"context_process_hashes":{"items":{"type":"string"},"type":"array","description":"List of hashes of processes to collect context data.\nEmpty implies all processes.\n","title":"List of hashes of processes to collect context data"},"enable_data_collection":{"default":true,"type":"boolean","description":"Enable NSX-Intelligence data collection in host nodes.\n\nThis property has been deprecated.\nTo enable flow data collection,\nuse property enable_flow_data_collection instead.\nTo enable context data collection,\nuse property enable_context_data_collection instead.\n\nWhen this property is set to false, no data collection\nis performed even if enable_flow_data_collection or\nenable_context_data_collection is set to true.\n\nWhen this property is set to true, property\nenable_flow_data_collection and enable_context_data_collection\ncontrol whether to collect flow data and context data separately.\n","x-deprecated":true,"title":"Enable data collection"},"enable_external_ip_aggregation":{"default":false,"type":"boolean","description":"When this property is set to true, if the source or destination\nof network traffic uses an IP address that is not included in\nproperty private_ip_prefix, it is reported as ANY (255.255.255.255)\nto NSX-Intelligence.\n\nWhen this property is set to false, the original IP addresses of\nnetwork traffic are reported to NSX-Intelligence,\nregardless whether they are included in property private_ip_prefix.\n","title":"Enable external IP aggregation"},"context_process_names":{"items":{"type":"string"},"type":"array","description":"List of processes to collect context data.\nEmpty implies all processes.\n","title":"List of processes to collect context data"},"broker_bootstrap_servers":{"items":{"$ref":"#/definitions/IntelligenceBrokerEndpointInfo"},"type":"array","description":"List of NSX-Intelligence broker endpoints that host nodes contact initially.\n","title":"List of NSX-Intelligence broker endpoints"},"max_inactive_flow_count_bm":{"description":"Maximum inactive network flow to collect in collection interval for Bare Metal server.\n","title":"Maximum inactive network flow for Bare Metal server","default":25000,"format":"int64","maximum":5000000,"minimum":1,"type":"integer"},"max_inactive_flow_count":{"description":"Maximum inactive network flow to collect in collection interval.\n","title":"Maximum inactive network flow","default":50000,"format":"int64","maximum":5000000,"minimum":1,"type":"integer"},"private_ip_prefix":{"items":{"$ref":"#/definitions/IntelligenceFlowPrivateIpPrefixInfo"},"type":"array","description":"List of private IP prefix that NSX-Intelligence network flow\nis collected from.\n","title":"List of private IP prefix"},"max_active_flow_count":{"description":"Maximum active network flow to collect in collection interval.\n","title":"Maximum active network flow","default":25000,"format":"int64","maximum":5000000,"minimum":1,"type":"integer"}}}],"description":"This is deprecated. Please use IntelligenceTransportNodeProfile instead.\nNSX-Intelligence configuration that can be applied to host nodes.\n","title":"NSX-Intelligence host configuration"},"ActiveStandbySyncStatus":{"x-vmw-nsx-module":"SiteManagerModule","required":["status","description","is_data_consistent","full_sync_status","standby_site","sync_type"],"type":"object","properties":{"status":{"enum":["UNAVAILABLE","ERROR","ONGOING","NOT_STARTED"],"type":"string","description":"Status of synchronization between active and standby Global Manager nodes.","title":"Status of synchronization between active and standby Global Manager nodes."},"full_sync_status":{"$ref":"#/definitions/FullSyncStatus"},"description":{"type":"string","description":"Description of the status.","title":"Description of the status."},"is_data_consistent":{"type":"boolean","description":"Indicates whether the data is consistent. Always returned as true when queried on an active Global Manager node.","title":"Indicates whether the data is consistent. Always returned as true when queried on an active Global Manager node."},"remaining_entries_to_send":{"format":"int64","type":"integer","description":"Number of entries pending synchronization. This value is only returned when queried on an active Global Manager node.","title":"Number of entries pending synchronization. This value is only returned when queried on an active Global Manager node."},"percentage_completed":{"format":"int64","type":"integer","description":"Percentage estimate of synchronization progress. Ranges from 0 to 100. This value is only returned when queried on an active Global Manager node.","title":"Percentage estimate of synchronization progress. Ranges from 0 to 100. This value is only returned when queried on an active Global Manager node."},"standby_site":{"type":"string","description":"Name of standby site.","title":"Name of standby site."},"sync_type":{"enum":["UNAVAILABLE","DELTA_SYNC","FULL_SYNC"],"type":"string","description":"Type of synchronization currently in effect between active and standby Global Manager nodes.","title":"Type of synchronization currently in effect between active and standby Global Manager nodes."}}},"UpgradeBundleFetchRequest":{"description":"URL and other fetch requests of upgrade bundle","title":"Fetch request for fetching upgrade bundle","required":["url"],"x-vmw-nsx-module":"Upgrade","type":"object","properties":{"url":{"readOnly":false,"type":"string","description":"URL for uploading upgrade bundle","title":"URL of upgrade bundle"}}},"AllocationRuleAction":{"description":"Define action for each allocation rule which added on edge cluster.\n","title":"Set action for allocation rule","required":["action_type"],"discriminator":"action_type","x-vmw-nsx-module":"EdgeClusters","type":"object","properties":{"action_type":{"description":"Set action for each allocation rule on edge cluster which will help in\nauto placement.\n","enum":["AllocationBasedOnFailureDomain"],"type":"string"}}},"NSSupportedAttributes":{"description":"Supported attributes and sub-attributes for NSProfile","title":"Supported attributes and sub-attributes for NSProfile","required":["ns_attributes"],"x-vmw-nsx-module":"NSProfile","type":"object","properties":{"ns_attributes":{"items":{"$ref":"#/definitions/NSAttributes"},"type":"array","description":"The type represent pre-defined or user defined list of supported attributes\nand sub-attributes that can be used while creating NSProfile\n","title":"Collection of supported attributes and sub-attributes"}}},"LbTcpMonitor":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/LbActiveMonitor"},{"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"receive":{"type":"string","description":"Expected data, if specified, can be anywhere in the response and it has to\nbe a string, regular expressions are not supported.\n","title":"expected data received from server"},"send":{"type":"string","description":"If both send and receive are not specified, then just a TCP connection\nis established (3-way handshake) to validate server is healthy, no\ndata is sent.\n","title":"data to send"}}}]},"LbPool":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"member_group":{"$ref":"#/definitions/PoolMemberGroup"},"snat_translation":{"$ref":"#/definitions/LbSnatTranslation"},"algorithm":{"description":"Load balancing algorithm, configurable per pool controls how the\nincoming connections are distributed among the members.\n","default":"ROUND_ROBIN","enum":["ROUND_ROBIN","WEIGHTED_ROUND_ROBIN","LEAST_CONNECTION","WEIGHTED_LEAST_CONNECTION","IP_HASH"],"type":"string"},"members":{"items":{"$ref":"#/definitions/PoolMember"},"type":"array","description":"Server pool consists of one or more pool members. Each pool member\nis identified, typically, by an IP address and a port.\n","title":"load balancer pool members"},"passive_monitor_id":{"type":"string","description":"Passive healthchecks are disabled by default and can be enabled by\nattaching a passive health monitor to a server pool.\nEach time a client connection to a pool member fails, its failed count\nis incremented. For pools bound to L7 virtual servers, a connection is\nconsidered to be failed and failed count is incremented if any TCP\nconnection errors (e.g. TCP RST or failure to send data) or SSL\nhandshake failures occur. For pools bound to L4 virtual servers, if no\nresponse is received to a TCP SYN sent to the pool member or if a TCP\nRST is received in response to a TCP SYN, then the pool member is\nconsidered to have failed and the failed count is incremented.\nThe property is deprecated as NSX-T Load Balancer is deprecated.\n","x-deprecated":true,"title":"passive monitor identifier"},"tcp_multiplexing_number":{"description":"The maximum number of TCP connections per pool that are idly kept alive\nfor sending future client requests.\nThe property is deprecated as NSX-T Load Balancer is deprecated.\n","title":"maximum number of TCP connections for multiplexing","default":6,"format":"int64","maximum":2147483647,"x-deprecated":true,"minimum":0,"type":"integer"},"active_monitor_ids":{"items":{"type":"string"},"type":"array","description":"In case of active healthchecks, load balancer itself initiates new\nconnections (or sends ICMP ping) to the servers periodically to check\ntheir health, completely independent of any data traffic. Active\nhealthchecks are disabled by default and can be enabled for a server\npool by binding a health monitor to the pool. If multiple active\nmonitors are configured, the pool member status is UP only when the\nhealth check status for all the monitors are UP.\nThe property is deprecated as NSX-T Load Balancer is deprecated.\n","x-deprecated":true,"title":"active monitor identifier list"},"tcp_multiplexing_enabled":{"default":false,"type":"boolean","description":"TCP multiplexing allows the same TCP connection between load balancer\nand the backend server to be used for sending multiple client requests\nfrom different client TCP connections.\nThe property is deprecated as NSX-T Load Balancer is deprecated.\n","x-deprecated":true,"title":"TCP multiplexing enable flag"},"min_active_members":{"description":"A pool is considered active if there are at least certain\nminimum number of members.\n","title":"minimum number of active pool members to consider pool as active","default":1,"format":"int64","maximum":2147483647,"minimum":1,"type":"integer"}}}]},"ComputeManager":{"x-vmw-nsx-module":"InventoryCmObj","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"InventoryCmObj","required":["origin_type","server"],"type":"object","properties":{"credential":{"$ref":"#/definitions/LoginCredential"},"set_as_oidc_provider":{"default":false,"readOnly":false,"type":"boolean","description":"If the compute manager is VC and need to set set as OIDC provider for NSX then\nthis flag should be set as true. This is specific to wcp feature, should be\nenabled when this feature is being used.\n","title":"Specifies whether compute manager has been set as OIDC provider"},"access_level_for_oidc":{"description":"Specifies the maximum access level allowed for calls from compute manager\nto NSX using the OIDC provider.\n","title":"Specifies access level to NSX from the compute manager","default":"FULL","enum":["FULL","LIMITED"],"readOnly":false,"type":"string"},"reverse_proxy_https_port":{"description":"Specifies https port of the reverse proxy to connect to compute manager.\nFor e.g. In case of VC, this port can be retrieved from this config\nfile /etc/vmware-rhttpproxy/config.xml.\n","title":"Proxy https port of compute manager","default":443,"format":"int64","maximum":65535,"readOnly":false,"minimum":1,"type":"integer"},"create_service_account":{"default":false,"readOnly":false,"type":"boolean","description":"Enable this flag to create service account user on compute manager. This is\nrequired by features such as vSphere Lifecycle Manager for authentication with\nvAPIs from nsx.\n","title":"Specifies whether service account is created or not on compute manager"},"origin_properties":{"items":{"$ref":"#/definitions/KeyValuePair"},"readOnly":true,"type":"array","description":"Key-Value map of additional specific properties of compute manager","title":"Key-Value map of additional specific properties of compute manager"},"origin_type":{"readOnly":false,"type":"string","description":"Compute manager type like vCenter","title":"Compute manager type like vCenter"},"server":{"readOnly":false,"format":"hostname-or-ip","type":"string","description":"IP address or hostname of compute manager","title":"IP address or hostname of compute manager"}}}]},"FilterRequest":{"description":"Filter request parameters","title":"Filter request","required":["field_names","value"],"x-vmw-nsx-module":"Search","type":"object","properties":{"field_names":{"type":"string","description":"Comma seperated fields to be filtered on","title":"Field Names"},"value":{"type":"string","description":"Filter value","title":"Value"},"case_sensitive":{"default":true,"type":"boolean","description":"Set this flag to true to make filtering case-sensitive.\n","title":"Flag to indicate whether filtering is case-sensitive or not"}}},"ExtraConfigHostSwitchProfile":{"x-vmw-nsx-module":"ExtraConfigHostSwitchProfile","allOf":[{"$ref":"#/definitions/BaseHostSwitchProfile"},{"x-vmw-nsx-module":"ExtraConfigHostSwitchProfile","type":"object","properties":{"extra_configs":{"items":{"$ref":"#/definitions/ExtraConfig"},"type":"array","description":"list of extra configs","title":"list of extra configs"}}}],"description":"Profile for extra configs in host switch","title":"Profile for extra configs in host switch"},"BfdConfig":{"x-vmw-nsx-module":"Routing","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"Routing","type":"object","properties":{"receive_interval":{"description":"the time interval (in milliseconds) between heartbeat packets for BFD when receiving heartbeats.","title":"Receive interval for heartbeats","default":500,"format":"int64","maximum":60000,"minimum":50,"type":"integer"},"declare_dead_multiple":{"description":"Number of times a packet is missed before BFD declares the neighbor down.","title":"Number of times a packet is missed before BFD declares the neighbor down.","default":3,"format":"int64","maximum":16,"minimum":2,"type":"integer"},"enabled":{"default":false,"type":"boolean","description":"Flag to enable BFD for this LogicalRouter","title":"Flag to enable BFD for this LogicalRouter"},"logical_router_id":{"readOnly":true,"type":"string","description":"Logical router id","title":"Logical router id"},"transmit_interval":{"description":"the time interval (in milliseconds) between heartbeat packets for BFD when sending heartbeats.","title":"Transmit interval for heartbeats","default":500,"format":"int64","maximum":60000,"minimum":50,"type":"integer"}}}],"description":"BFD configuration for LogicalRouter","title":"BFD configuration for LogicalRouter"},"Icon":{"x-vmw-nsx-module":"NsxDashboard","type":"object","description":"Icon to be applied at dashboard for widgets and UI elements.","properties":{"placement":{"default":"PRE","enum":["PRE","POST"],"type":"string","description":"If specified as PRE, the icon appears before the UI element. If set as POST, the icon appears after the UI element.","title":"Position at which to display icon, if any"},"color":{"type":"string","description":"Icon color applied to icon in hex format.","title":"Icon color applied to icon in hex format"},"type":{"type":"string","description":"Icon will be rendered based on its type. For example, if ERROR is chosen, then icon representing error will be rendered. or else custom svg icon name can be given.","title":"Type of icon"},"size_unit":{"enum":["px","rem","pc"],"type":"string","description":"Icon size unit applied to icon along with size. if 'size' property value is provided and no value is provided for this property then default value for this proerty is set to 'px'.","title":"Icon size unit in rem/px/pc"},"tooltip":{"items":{"$ref":"#/definitions/Tooltip"},"type":"array","description":"Multi-line text to be shown on tooltip while hovering over the icon.","title":"Multi-line tooltip"},"size":{"minimum":1,"type":"number","description":"Icon size in unit applied to icon.A unit can be specified by the 'size_unit' property.","title":"Icon size in unit"}},"title":"Icon"},"LbPersistenceProfile":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/ManagedResource"},{"required":["resource_type"],"discriminator":"resource_type","x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"persistence_shared":{"default":false,"type":"boolean","description":"The persistence shared flag identifies whether the persistence table\nis shared among virtual-servers referring this profile.\nIf persistence shared flag is not set in the cookie persistence profile\nbound to a virtual server, it defaults to cookie persistence that is\nprivate to each virtual server and is qualified by the pool. This is\naccomplished by load balancer inserting a cookie with name in the\nformat <name>.<virtual_server_id>.<pool_id>.\nIf persistence shared flag is set in the cookie persistence profile, in\ncookie insert mode, cookie persistence could be shared across multiple\nvirtual servers that are bound to the same pools. The cookie name would\nbe changed to <name>.<profile-id>.<pool-id>.\nIf persistence shared flag is not set in the sourceIp persistence\nprofile bound to a virtual server, each virtual server that the profile\nis bound to maintains its own private persistence table.\nIf persistence shared flag is set in the sourceIp persistence profile,\nall virtual servers the profile is bound to share the same persistence\ntable.\nIf persistence shared flag is not set in the generic persistence\nprofile, the persistence entries are matched and stored in the table\nwhich is identified using both virtual server ID and profile ID.\nIf persistence shared flag is set in the generic persistence profile,\nthe persistence entries are matched and stored in the table which is\nidentified using profile ID. It means that virtual servers which\nconsume the same profile in the LbRule with this flag enabled are\nsharing the same persistence table.\n","title":"Persistence shared flag"},"resource_type":{"description":"The resource_type property identifies persistence profile type.\n","enum":["LbCookiePersistenceProfile","LbSourceIpPersistenceProfile","LbGenericPersistenceProfile"],"type":"string"}}}],"description":"LB persistence profile contains the information related to load balancer\npersistence options.\nSome applications maintain state and require all relevant connections\nto be sent to the same server as the application state is not\nsynchronized among servers. Persistence can be enabled on a\nLbVirtualServer by binding a persistence profile to it.\nLbGenericPersistenceProfile cannot be attached to virtual server directly,\nit can be only consumed by LB rule action. If a user attaches a generic\npersistence profile directly to a virtual server, the operation is\nrejected.\n","title":"LB persistence profile"},"VirtualMachine":{"x-vmw-nsx-module":"Inventory","allOf":[{"$ref":"#/definitions/DiscoveredResource"},{"x-vmw-nsx-module":"Inventory","required":["local_id_on_host","external_id","power_state","compute_ids"],"type":"object","properties":{"source":{"$ref":"#/definitions/ResourceReference"},"local_id_on_host":{"type":"string","description":"Id of the vm unique within the host.","title":"Id of the vm unique within the host."},"type":{"readOnly":true,"enum":["EDGE","SERVICE","REGULAR","MP","INTELLIGENCE","VC_SYSTEM","UNKNOWN"],"type":"string","description":"Virtual Machine type; Edge, Service VM or other.","title":"Virtual Machine type; Edge, Service VM or other."},"guest_info":{"$ref":"#/definitions/GuestInfo"},"power_state":{"enum":["VM_RUNNING","VM_STOPPED","VM_SUSPENDED","UNKNOWN"],"type":"string","description":"Current power state of this virtual machine in the system.","title":"Current power state of this virtual machine in the system."},"compute_ids":{"items":{"type":"string"},"type":"array","description":"List of external compute ids of the virtual machine in the format 'id-type-key:value' , list of external compute ids ['uuid:xxxx-xxxx-xxxx-xxxx', 'moIdOnHost:moref-11', 'instanceUuid:xxxx-xxxx-xxxx-xxxx']","title":"List of external compute ids of the virtual machine in the format 'id-type-key:value' , list of external compute ids ['uuid:xxxx-xxxx-xxxx-xxxx', 'moIdOnHost:moref-11', 'instanceUuid:xxxx-xxxx-xxxx-xxxx']"},"host_id":{"type":"string","description":"Id of the host in which this virtual machine exists.","title":"Id of the host in which this virtual machine exists."},"external_id":{"type":"string","description":"Current external id of this virtual machine in the system.","title":"Current external id of this virtual machine in the system."}}}]},"TaskProperties":{"x-vmw-nsx-module":"Common","allOf":[{"$ref":"#/definitions/Resource"},{"x-vmw-nsx-module":"Common","type":"object","properties":{"status":{"description":"Current status of the task","enum":["running","error","success","canceling","canceled","killed"],"readOnly":true,"type":"string"},"async_response_available":{"readOnly":true,"type":"boolean","description":"True if response for asynchronous request is available","title":"True if response for asynchronous request is available"},"description":{"readOnly":true,"type":"string","description":"Description of the task","title":"Description of the task"},"start_time":{"description":"The start time of the task in epoch milliseconds","format":"int64","readOnly":true,"type":"integer"},"cancelable":{"readOnly":true,"type":"boolean","description":"True if this task can be canceled","title":"True if this task can be canceled"},"request_method":{"readOnly":true,"type":"string","description":"HTTP request method","title":"HTTP request method"},"user":{"readOnly":true,"type":"string","description":"Name of the user who created this task","title":"Name of the user who created this task"},"progress":{"description":"Task progress if known, from 0 to 100","title":"Task progress if known, from 0 to 100","format":"int64","maximum":100,"readOnly":true,"minimum":0,"type":"integer"},"message":{"readOnly":true,"type":"string","description":"A message describing the disposition of the task","title":"A message describing the disposition of the task"},"request_uri":{"readOnly":true,"type":"string","description":"URI of the method invocation that spawned this task","title":"URI of the method invocation that spawned this task"},"id":{"readOnly":true,"type":"string","description":"Identifier for this task","title":"Identifier for this task"},"end_time":{"description":"The end time of the task in epoch milliseconds","format":"int64","readOnly":true,"type":"integer"}}}],"description":"Task properties","title":"Task properties"},"DeploymentTemplate":{"x-vmw-nsx-module":"ServiceInsertionCommonTypes","type":"object","description":"Deployment Template holds the attributes specific to partner for which the service is created. These attributes are opaque to NSX.","properties":{"attributes":{"description":"List of attributes specific to a partner for which the service is created. There attributes are passed on to the partner appliance and is opaque to the NSX Manager.","title":"Deployment Template attributes","items":{"$ref":"#/definitions/Attribute"},"readOnly":false,"maxItems":128,"type":"array"},"name":{"readOnly":false,"type":"string","description":"Deployment Template name.","title":"name"}},"title":"Service Deployment Template"},"ConfigurationStateElement":{"x-vmw-nsx-module":"Common","type":"object","description":"Describes status of configuration of an entity","properties":{"sub_system_address":{"readOnly":true,"type":"string","description":"URI of backing resource on sub system","title":"URI of backing resource on sub system"},"state":{"readOnly":true,"enum":["in_progress","success","failed","partial_success","in_sync","VM_DEPLOYMENT_FAILED","VM_POWER_ON_FAILED","VM_POWER_OFF_FAILED","VM_UNDEPLOY_FAILED","REPLACE_FAILED","UPLINK_FROM_TEAMING_POLICY_NOT_MAPPED","LOGICAL_SWITCH_NAMED_TEAMING_HAS_NO_PNIC_BACKING","DELETE_VM_IN_REDEPLOY_FAILED","DEPLOY_VM_IN_REDEPLOY_FAILED","INSUFFICIENT_RESOURCES_IN_EDGE_NODE_FOR_SERVICE","EDGE_CONFIG_ERROR","REGISTRATION_FAILED","TRANSPORT_NODE_CONFIGURATION_MISSING","EDGE_HARDWARE_NOT_SUPPORTED","MULTIPLE_OVERLAY_TZS_NOT_SUPPORTED","TN_OVERLAY_TZ_IN_USE_BY_EDGE_CLUSTER","TZ_ENDPOINTS_NOT_SPECIFIED","NO_PNIC_PREPARED_IN_EDGE","APPLIANCE_INTERNAL_ERROR","VTEP_DHCP_NOT_SUPPORTED","UNSUPPORTED_HOST_SWITCH_PROFILE","UPLINK_HOST_SWITCH_PROFILE_NOT_SPECIFIED","HOSTSWITCH_PROFILE_NOT_FOUND","LLDP_SEND_ENABLED_NOT_SUPPORTED","UNSUPPORTED_NAMED_TEAMING_POLICY","LBSRCID_NOT_SUPPORTED_FOR_EDGE_VM","LACP_NOT_SUPPORTED_FOR_EDGE_VM","STANDBY_UPLINKS_NOT_SUPPORTED_FOR_EDGE_VM","MULTIPLE_ACTIVE_UPLINKS_NOT_SUPPORTED_FOR_EDGE","UNSUPPORTED_LACP_LB_ALGO_FOR_NODE","EDGE_NODE_VERSION_NOT_SUPPORTED","NO_PNIC_SPECIFIED_IN_TN","INVALID_PNIC_DEVICE_NAME","UNSUPPORTED_DEFAULT_TEAMING_POLICY","MPA_DISCONNECTED","VM_NETWORK_EDIT_PENDING","VM_RENAME_PENDING","VM_CONFIG_EDIT_PENDING","VM_NETWORK_EDIT_FAILED","VM_RENAME_FAILED","VM_CONFIG_EDIT_FAILED","VM_CONFIG_DISCREPANCY","VM_NODE_REFRESH_FAILED","VM_PLACEMENT_REFRESH_FAILED","NOT_AVAILABLE","REGISTRATION_TIMEDOUT","pending","orphaned","unknown","error"],"type":"string","description":"State of configuration on this sub system","title":"State of configuration on this sub system"},"failure_code":{"readOnly":true,"format":"int64","type":"integer","description":"Error code","title":"Error code"},"sub_system_name":{"readOnly":true,"type":"string","description":"Name of backing resource on sub system","title":"Name of backing resource on sub system"},"failure_message":{"readOnly":true,"type":"string","description":"Error message in case of failure","title":"Error message in case of failure"},"sub_system_type":{"readOnly":true,"type":"string","description":"Type of backing resource on sub system","title":"Type of backing resource on sub system"},"sub_system_id":{"readOnly":true,"type":"string","description":"Identifier of backing resource on sub system","title":"Identifier of backing resource on sub system"}},"title":"Describes status of configuration of an entity"},"DestinationNsxApiEndpoint":{"description":"Details about the destination NSX manager for the migration","title":"Destination NSX manager details","required":["destination_nsx_ip"],"x-vmw-nsx-module":"Migration","type":"object","properties":{"destination_nsx_ip":{"readOnly":false,"format":"hostname-or-ip","type":"string","description":"IP address or host name of the destination NSX manager to which the config will be migrated.","title":"Destination NSX IP ddress or host name"},"destination_nsx_password":{"readOnly":false,"type":"string","description":"Valid password for connecting to the destination NSX manager.","title":"Password for destination NSX manager"},"destination_nsx_port":{"description":"Destination NSX manager port that will be used to apply details.","format":"int32","default":443,"title":"Destination NSX manager port","readOnly":false,"type":"integer"},"destination_nsx_username":{"readOnly":false,"type":"string","description":"Valid username for connecting to the destination NSX manager.","title":"Username for destination NSX manager"}}},"WeeklyTelemetrySchedule":{"x-vmw-nsx-module":"TelemetryConfig","allOf":[{"$ref":"#/definitions/TelemetrySchedule"},{"x-vmw-nsx-module":"TelemetryConfig","required":["hour_of_day","day_of_week"],"type":"object","properties":{"minutes":{"description":"Minute at which data will be collected. Specify a value between 0 through 59.\n","title":"Minute at which data will be collected","default":0,"format":"int64","maximum":59,"minimum":0,"type":"integer"},"hour_of_day":{"description":"Hour at which data will be collected. Specify a value between 0 through 23.\n","format":"int64","title":"Hour at which data will be collected","maximum":23,"minimum":0,"type":"integer"},"day_of_week":{"enum":["SUNDAY","MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY"],"type":"string","description":"Day of week on which data will be collected. Specify one of SUNDAY through SATURDAY.\n","title":"Day of week on which data will be collected"}}}]},"NSSupportedAttributeTypesResult":{"x-vmw-nsx-module":"NSProfile","type":"object","description":"NSSupportedAttributes Types","properties":{"attribute_types":{"items":{"type":"string"},"readOnly":true,"type":"array","description":"List of NSSupportedAttributes types","title":"List of NSSupportedAttributes types"}},"title":"NSSupportedAttributes Types"},"LineChartPlotConfiguration":{"x-vmw-nsx-module":"NsxDashboard","allOf":[{"$ref":"#/definitions/WidgetPlotConfiguration"},{"x-vmw-nsx-module":"NsxDashboard","type":"object","properties":{"show_curved_lines":{"default":true,"type":"boolean","description":"Used for displaying the curved lines for a series in a line chart. By default,\nstraight line is used to for a series in a line chart.\n","title":"Show curved lines for series"},"show_unit_in_tooltip":{"default":false,"type":"boolean","description":"Show the data unit in tooltip.\n","title":"Show data unit in tooltip."},"fill_gradient_area":{"type":"boolean","description":"Fill the line chart area with a gradient series color.\n","title":"Fill the line chart area with a gradient series color."},"show_grid_lines":{"default":true,"type":"boolean","description":"Controls the visiblity of the grid lines in\nline chart.\n","title":"Show grid lines"},"show_min_max_on_series":{"default":false,"type":"boolean","description":"Controls the visiblity of the min and max value\nacross line series in line chart.\n","title":"Show min and max value on line series"},"sort_data_in_grouped_tooltip":{"default":false,"type":"boolean","description":"Sort the data in grouped tooltip.\n","title":"Sort the data in grouped tooltip"},"sort_series":{"default":false,"type":"boolean","description":"Specifies whether the series should be sorted by the latest data point.\n","title":"Perform sorting on series using the latest data point"},"show_grouped_tooltip":{"default":false,"type":"boolean","description":"Controls the visiblity of the grouped tooltip in a\nline chart across all series.\n","title":"Derives to show the grouped tooltip"},"show_data_in_tooltip":{"default":false,"type":"boolean","description":"Show the data in tooltip.\n","title":"Show data in tooltip."},"num_of_series_to_display":{"description":"Specifies the number of series to be displayed in a line chart. If no value is provided all the series will be displayed.","format":"int32","title":"A number of series to be displayed upfront.","maximum":16,"minimum":1,"type":"integer"},"show_data_points":{"default":true,"type":"boolean","description":"Controls the visiblity of the data points on the line\nchart. If value is set to false data points wont be high-\nlighted on the lines.\n","title":"Show the Data point highlighting in line chart"}}}],"description":"A line chart plotting configuration.","title":"A line chart plotting configuration"},"ServiceChain":{"x-vmw-nsx-module":"ServiceInsertionCommonTypes","allOf":[{"$ref":"#/definitions/ManagedResource"},{"required":["service_attachments","forward_path_service_profiles"],"x-vmw-nsx-module":"ServiceInsertionCommonTypes","type":"object","properties":{"reverse_path_service_profiles":{"description":"List of ServiceInsertionServiceProfiles id. Reverse path service profiles are applied to egress traffic and is optional. 2 different set of profiles can be defined for forward and reverse path. If not defined, the reverse of the forward path service profile is applied.","title":"Reverse path service profiles","items":{"$ref":"#/definitions/ResourceReference"},"readOnly":false,"maxItems":4,"type":"array"},"service_attachments":{"description":"Service attachment specifies the scope i.e Service plane at which the SVMs are deployed.","title":"Service Attachment list","minItems":1,"items":{"$ref":"#/definitions/ResourceReference"},"readOnly":false,"maxItems":1,"type":"array"},"forward_path_service_profiles":{"description":"List of ServiceInsertionServiceProfiles that constitutes the the service chain. The forward path service profiles are applied to ingress traffic.","title":"Forward path service profiles","items":{"$ref":"#/definitions/ResourceReference"},"readOnly":false,"maxItems":4,"type":"array"},"service_chain_id":{"readOnly":true,"type":"string","description":"A unique id generated for every service chain. This is not a uuid.","title":"Service chain id"},"path_selection_policy":{"description":"Path selection policy can be - ANY - Service Insertion is free to redirect to any service path regardless of any load balancing considerations or flow pinning. LOCAL - means to prefer local service insances. REMOTE - preference is to redirect to the SVM co-located on the same host.","title":"Path Selection Policy","default":"ANY","enum":["ANY","LOCAL","REMOTE"],"readOnly":false,"type":"string"},"on_failure_policy":{"description":"Failure policy for the service tells datapath, the action to take i.e to allow or block traffic during failure scenarios.","title":"On Failure Policy","default":"ALLOW","enum":["ALLOW","BLOCK"],"readOnly":false,"type":"string"}}}],"description":"Service chain is a set of network Services. A Service chain is made up of ordered list of service profiles belonging to any same or different services.","title":"Service Chain"},"VmToolsInfoListResult":{"x-vmw-nsx-module":"VmToolsInfo","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"VmToolsInfo","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/VmToolsInfo"},"type":"array","description":"VmToolsInfo list results.","title":"VmToolsInfo list results."}}}]},"SnmpProperties":{"x-vmw-nsx-module":"CentralConfig","type":"object","description":"This object contains SNMP v2c and SNMP v3 properties.","properties":{"v2c":{"$ref":"#/definitions/Snmpv2cProperties"},"v3":{"$ref":"#/definitions/Snmpv3Properties"}},"title":"SNMP Service properties"},"ClusterNodeConfigListResult":{"x-vmw-nsx-module":"ClusterManagement","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"ClusterManagement","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/ClusterNodeConfig"},"type":"array","description":"Cluster node configuration results","title":"Cluster node configuration results"}}}]},"ClusterBackupInfo":{"x-vmw-nsx-module":"ClusterRestore","type":"object","description":"Cluster backup details","properties":{"timestamp":{"description":"timestamp of the cluster backup file","format":"int64","readOnly":true,"type":"integer"},"node_id":{"readOnly":true,"type":"string","description":"ID of the node from which the backup was taken","title":"ID of the node from which the backup was taken"},"ip_address":{"readOnly":true,"format":"hostname-or-ip","type":"string","description":"IP address or FQDN of the node from which the backup was taken","title":"IP address or FQDN of the node from which the backup was taken"},"restore_type":{"description":"Type of restore allowed","title":"Type of restore allowed","default":[],"items":{"enum":["REGULAR_RESTORE","POLICY_ONLY_RESTORE"],"type":"string"},"readOnly":true,"uniqueItems":true,"type":"array"}},"title":"Cluster backup details"},"PrincipalIdentityWithCertificate":{"x-vmw-nsx-module":"CertificateManager","allOf":[{"$ref":"#/definitions/PrincipalIdentity"},{"x-vmw-nsx-module":"CertificateManager","required":["certificate_pem"],"type":"object","properties":{"certificate_pem":{"readOnly":false,"type":"string","description":"PEM encoding of the new certificate.","title":"PEM encoding of the new certificate"}}}]},"UpgradeUnitGroupStatusListResult":{"x-vmw-nsx-module":"Upgrade","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"Upgrade","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/UpgradeUnitGroupStatus"},"readOnly":true,"type":"array","description":"Paged collection of upgrade status for upgrade unit groups","title":"Paged collection of upgrade status for upgrade unit groups"}}}]},"BgpRouteAggregation":{"x-vmw-nsx-module":"Routing","required":["prefix"],"type":"object","properties":{"summary_only":{"default":true,"type":"boolean","description":"Flag to send only summarized route","title":"Flag to send only summarized route"},"prefix":{"description":"cidr of the aggregate address","format":"ip-cidr-block","type":"string"}}},"TransportZone":{"x-vmw-nsx-module":"TransportZone","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"TransportZone","required":["transport_type"],"type":"object","properties":{"is_default":{"default":false,"type":"boolean","description":"Only one transport zone can be the default one for a given transport zone type. APIs that need transport zone can choose to use the default transport zone if a transport zone is not given.","title":"Flag to indicate if the transport zone is the default one."},"transport_type":{"description":"The transport type of this transport zone.","enum":["OVERLAY","VLAN"],"type":"string"},"origin_id":{"readOnly":true,"type":"string","description":"This field is populated only if the transport zone was created by NSX system to support security on vSphere Distributed Switch (vDS). The origin_id will refer to the identifier of corresponding vDS from it's parent vCenter server.","title":"The host switch id generated by the system."},"nested_nsx":{"default":false,"type":"boolean","description":"This flag should be set to true in nested NSX environment. When the \"allow_changing_vdr_mac_in_use\" property in the global config object RoutingGlobalConfig is false, this flag can not be changed if this transport zone is OVERLAY and the change will make any transport node in this transport zone to change the VDR MAC used in any host switch. When this flag is true and this transport zone is OVERLAY, all host switches in this transport zone will use the VDR MAC in the \"vdr_mac_nested\" property in the global config object RoutingGlobalConfig.","title":"Flag to indicate if all transport nodes in this transport zone are connected through nested NSX."},"uplink_teaming_policy_names":{"items":{"type":"string"},"type":"array","description":"The names of switching uplink teaming policies that all transport nodes in this transport zone must support. An exception will be thrown if a transport node within the transport zone does not support a named teaming policy. The user will need to first ensure all trasnport nodes support the desired named teaming policy before assigning it to the transport zone. If the field is not specified, the host switch's default teaming policy will be used.","title":"Names of the switching uplink teaming policies that are supported by this transport zone."},"transport_zone_profile_ids":{"items":{"$ref":"#/definitions/TransportZoneProfileTypeIdEntry"},"type":"array","description":"Identifiers of the transport zone profiles associated with this TransportZone.","title":"Identifiers of the transport zone profiles associated with this TransportZone."}}}]},"MigrationSwitchListResult":{"x-vmw-nsx-module":"Migration","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"Migration","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/MigrationSwitchInfo"},"readOnly":false,"type":"array","description":"A paginated list of DVS/VSS present on the VC.","title":"Paginated list of DVS/VSS present on the VC"}}}],"description":"Details about all the DVS and VSS present on the VC","title":"Details about all the DVS and VSS present on the VC"},"CapacityUsage":{"x-vmw-nsx-module":"License","description":"usage of each capacity type ex. vm, cpu","allOf":[{"$ref":"#/definitions/Resource"},{"x-vmw-nsx-module":"License","type":"object","properties":{"usage_count":{"readOnly":true,"format":"int64","type":"integer","description":"count of number of items of capacity_type","title":"count of number of items of capacity_type"},"capacity_type":{"readOnly":true,"type":"string","description":"type of the capacity field","title":"type of the capacity field"}}}]},"TransportNodeProfile":{"x-vmw-nsx-module":"TransportNodeProfile","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"TransportNodeProfile","type":"object","properties":{"host_switch_spec":{"$ref":"#/definitions/HostSwitchSpec"},"ignore_overridden_hosts":{"default":false,"type":"boolean","description":"Transport Node Profiles specify the configuration that is applied to all\nhosts in a cluster. The user has the ability to update the configuration\non individual hosts within a cluster which will cause the host configuration\nto differ from the Transport Node Profile and results in the host to be\nmarked as overridden. If a Transport Node Profile is edited or a new\nTransport Node Profile is applied on a Transport Node Collection, by default,\nthe host configuration will be overwritten with the Transport Node Profile\nconfiguration and the overridden flag will be reset to false. This flag\nshould be used when hosts that are set as overridden should not adopt the\nTransport Node Profile configuration when it is being updated or a new one\nis applied to the Transport Node Collection. In other words, when this flag is\nset to the default value of false and configuration is applied at the cluster\nlevel, the configuration will be applied on all hosts regardless if overridden\nor not. When this flag is set to true, all hosts that are set as overridden, i.e.,\nhave been updated invidivually, will be ignored and the cluster-level configuration\nwill not be applied.\nNote, Transport Node Profiles can be applied on multiple clusters. This field will\ndictate the behavior followed by all clusters using this Transport Node Profile.\n","title":"Determines if cluster-level configuration should be applied on overridden hosts"}}}],"description":"Transport Node Profile","title":"Transport Node Profile"},"DhcpRelayProfile":{"x-vmw-nsx-module":"DhcpRelay","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"DhcpRelay","required":["server_addresses"],"type":"object","properties":{"server_addresses":{"items":{"description":"IPv4 or IPv6 address","format":"ip","type":"string"},"type":"array"}}}]},"MonitoringEvent":{"x-vmw-nsx-module":"Monitoring","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"Monitoring","required":["threshold","sensitivity"],"type":"object","properties":{"is_threshold_fixed":{"readOnly":true,"type":"boolean","description":"Indicates if the threshold property is configurable via the API.\n","title":"Flag to indicate if threshold can be configured"},"event_type":{"readOnly":true,"type":"string","description":"Name of Event, e.g. manager_cpu_usage_high, certificate_expired.\n","title":"Name of event type"},"max_threshold":{"readOnly":true,"format":"int64","type":"integer","description":"Maximum allowed threshold value if the threshold is configurable\nand a maximum value is applicable.\n","title":"Maximum allowed threshold value"},"recommended_action":{"readOnly":true,"type":"string","description":"Recommended action for the alarm condition.\n","title":"Recommended action steps"},"sensitivity":{"description":"Percentage of samples to consider and used in combination with\nthreshold when determining whether an Event instance status is True or\nFalse. Event evaluation uses sampling to determine Event instance\nstatus. A higher sensitivity value specifies that more samples are used\nto ensure accuracy and ignore infrequent or rare spikes in sampled data.\n","format":"int64","title":"Percentage of samples to consider","maximum":100,"minimum":0,"type":"integer"},"is_disabled":{"default":false,"type":"boolean","description":"Flag to indicate whether sampling for this Event is off or on.\n","title":"Indicate if event sampling is disabled"},"feature_name":{"readOnly":true,"type":"string","description":"Feature defining this Event, e.g. manager_health, certificates.\n","title":"Feature defining this event"},"threshold":{"format":"int64","type":"integer","description":"Threshold to determine if a single sample is True. For example,\nif the configured threshold is 95% and the current CPU sample is\n99%, then the current sample is considered True.\nNote, if is_threshold_floating_point is true, the threshold_floating_point\nproperty is used to indicate the threshold value.\n","title":"Threshold to determine if a single sample is True"},"event_type_display_name":{"readOnly":true,"type":"string","description":"Display name of Event type.\n","title":"Display name of event type"},"summary":{"readOnly":true,"type":"string","description":"Summary description of the event.\n","title":"Summary description of Event"},"id":{"readOnly":true,"type":"string","description":"Unique identifier in the form of feature_name.event_type.\n","title":"Identifier to identify an event_type uniquely"},"threshold_unit_type":{"readOnly":true,"enum":["DAYS","PERCENT","SECONDS"],"type":"string","description":"Identifies the unit type of the threshold value.","title":"Identifies the unit type of the threshold value"},"threshold_floating_point":{"type":"number","description":"Floating point threshold to determine if a single sample is True.\nFor example, if the configured threshold is 66.6 percent and the\nsample value is 68.8 percent, the current sample is considered\nTrue. Note, if is_threshold_floating_point is false, the threshold\nproperty is used to indicate the threshold value.\n","title":"Floating point threshold to determine if a single sample is True"},"event_false_snmp_oid":{"readOnly":true,"type":"string","description":"Optional field containing OID for SNMP trap sent when\nEvent instance is False. This value is null if\nsuppress_snmp_trap or suppress_clear_oid is True.\n","title":"OID for SNMP trap sent when Event instance is False"},"description_on_clear":{"readOnly":true,"type":"string","description":"Description of Event when an Event instance transitions from True to\nFalse.\n","title":"Description of event when cleared"},"severity":{"description":"Severity of the Event.Can be one of - CRITICAL, HIGH, MEDIUM, LOW.\n","enum":["CRITICAL","HIGH","MEDIUM","LOW"],"readOnly":true,"type":"string"},"feature_display_name":{"readOnly":true,"type":"string","description":"Display name of feature defining this Event.\n","title":"Display name of feature"},"node_types":{"description":"Array identifying the nodes on which this Event is applicable.\nCan be one or more of the following values - nsx_public_cloud_gateway,\nnsx_edge, nsx_esx, nsx_kvm, nsx_manager.\n","title":"Array identifying the nodes on which this Event is applicable","items":{"enum":["nsx_autonomous_edge","nsx_bms","nsx_edge","nsx_esx","nsx_global_manager","nsx_intelligence","nsx_kvm","nsx_manager","nsx_public_cloud_gateway"],"type":"string"},"readOnly":true,"uniqueItems":true,"type":"array"},"min_threshold":{"readOnly":true,"format":"int64","type":"integer","description":"Minimum allowed threshold value if the threshold is configurable\nand a minimum value is applicable.\n","title":"Minimum allowed threshold value"},"description":{"readOnly":true,"type":"string","description":"Detailed description of the event.\n","title":"Detailed description of Event"},"suppress_alarm":{"default":false,"type":"boolean","description":"Flag to suppress Alarm generation. Alarms are not generated\nfor this Event when this is set to True.\n","title":"Flag to suppress Alarm generation"},"is_threshold_floating_point":{"readOnly":true,"type":"boolean","description":"Flag to indicate if the threshold for this Event is a floating point\nnumber. If this value is true, the threshold_floating_point property\nis used to indicate the threshold at runtime; otherwise, the threshold\nproperty is used.\n","title":"Indicates if the threshold for this Event is a floating point value.\n"},"event_true_snmp_oid":{"readOnly":true,"type":"string","description":"Optional field containing OID for SNMP trap sent when\nEvent instance is True. This value is null if\nsuppress_snmp_trap is True.\n","title":"OID for SNMP trap sent when Event instance is True"},"entity_resource_type":{"readOnly":true,"type":"string","description":"Resource Type of entity where this event is applicable\neg. LogicalSwitch, LogicalPort etc.\n","title":"Resource Type of entity where this event is applicable"},"suppress_snmp_trap":{"default":false,"type":"boolean","description":"Flag to suppress SNMP trap generation. SNMP traps are not\nsent for this Event when this is set to True.\n","title":"Flag to suppress SNMP trap generation"},"is_sensitivity_fixed":{"readOnly":true,"type":"boolean","description":"Indicates if the sensitivity property is configurable via the API.\n","title":"Flag to indicate if sensitivity can be configured"}}}]},"IntelligenceFlowPrivateIpPrefixInfo":{"description":"This is deprecated. Please use CommonAgentPrivateIpRangeInfo instead.\nAn IP prefix to mark the private network that NSX-Intelligence\nnetwork flow is collected from.\n","title":"NSX-Intelligence flow private IP prefix","required":["address_type","prefix_length","address"],"x-vmw-nsx-module":"NsxIntelligenceHostConfiguration","type":"object","properties":{"address_type":{"enum":["IPV4","IPV6"],"type":"string","description":"The type of IP address.\n","title":"IP address type"},"prefix_length":{"description":"The length of IP address prefix that marks the range of private network.\n","format":"int64","title":"IP prefix length","maximum":128,"minimum":1,"type":"integer"},"address":{"description":"The prefix of IP address that marks the range of private network.\n","format":"ip","type":"string"}}},"ApplianceManagementTaskProperties":{"x-vmw-nsx-module":"MISSING_MODULE","allOf":[{"$ref":"#/definitions/Resource"},{"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"status":{"description":"Current status of the task","enum":["running","error","success","canceling","canceled","killed"],"readOnly":true,"type":"string"},"async_response_available":{"readOnly":true,"type":"boolean","description":"True if response for asynchronous request is available","title":"True if response for asynchronous request is available"},"description":{"readOnly":true,"type":"string","description":"Description of the task","title":"Description of the task"},"start_time":{"description":"The start time of the task in epoch milliseconds","format":"int64","readOnly":true,"type":"integer"},"details":{"readOnly":true,"type":"object","description":"Details about the task if known","title":"Details about the task if known"},"cancelable":{"readOnly":true,"type":"boolean","description":"True if this task can be canceled","title":"True if this task can be canceled"},"request_method":{"readOnly":true,"type":"string","description":"HTTP request method","title":"HTTP request method"},"end_time":{"description":"The end time of the task in epoch milliseconds","format":"int64","readOnly":true,"type":"integer"},"progress":{"description":"Task progress if known, from 0 to 100","title":"Task progress if known, from 0 to 100","format":"int64","maximum":100,"readOnly":true,"minimum":0,"type":"integer"},"message":{"readOnly":true,"type":"string","description":"A message describing the disposition of the task","title":"A message describing the disposition of the task"},"user":{"readOnly":true,"type":"string","description":"Name of the user who created this task","title":"Name of the user who created this task"},"id":{"readOnly":true,"type":"string","description":"Identifier for this task","title":"Identifier for this task"},"request_uri":{"readOnly":true,"type":"string","description":"URI of the method invocation that spawned this task","title":"URI of the method invocation that spawned this task"}}}],"description":"Appliance management task properties","title":"Appliance management task properties"},"BgpNeighborRouteDetailsCsvRecord":{"x-vmw-nsx-module":"AggSvcLogicalRouter","allOf":[{"$ref":"#/definitions/CsvRecord"},{"x-vmw-nsx-module":"AggSvcLogicalRouter","type":"object","properties":{"med":{"readOnly":true,"format":"int64","type":"integer","description":"BGP Multi Exit Discriminator attribute.","title":"Multi Exit Discriminator"},"network":{"description":"CIDR network address.","format":"ip-cidr-block","readOnly":true,"type":"string"},"weight":{"readOnly":true,"format":"int64","type":"integer","description":"BGP Weight attribute.","title":"Weight"},"transport_node_id":{"readOnly":true,"type":"string","description":"Transport node id","title":"Transport node id"},"as_path":{"readOnly":true,"type":"string","description":"BGP AS path attribute.","title":"AS path"},"next_hop":{"description":"Next hop IP address.","format":"ip","readOnly":true,"type":"string"},"logical_router_id":{"readOnly":true,"type":"string","description":"Logical router id","title":"Logical router id"},"local_pref":{"readOnly":true,"format":"int64","type":"integer","description":"BGP Local Preference attribute.","title":"Local preference"},"source_address":{"description":"BGP neighbor source address.","format":"ip","readOnly":true,"type":"string"},"neighbor_id":{"readOnly":true,"type":"string","description":"BGP neighbor id","title":"BGP neighbor id"},"neighbor_address":{"description":"BGP neighbor peer IP address.","format":"ip","readOnly":true,"type":"string"}}}],"description":"BGP neighbor learned/advertised route details.","title":"BGP neighbor route details"},"CloudNativeServiceInstanceListResult":{"x-vmw-nsx-module":"InventoryCloudObj","description":"Stores a list of cloud native service instances and information about them.\nNSX supported service instances are currently limited to\nRelational Database Service (RDS),Elastic Load Balancing (ELB).\n","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"InventoryCloudObj","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/CloudNativeServiceInstance"},"type":"array","description":"List of cloud native service instances","title":"CloudNativeServiceInstance list results"}}}]},"NodeCapabilitiesResult":{"description":"List of capabilities of a fabric node","title":"List of capabilities of a fabric node","required":["capabilities"],"x-vmw-nsx-module":"FabricNode","type":"object","properties":{"capabilities":{"items":{"$ref":"#/definitions/NodeCapability"},"type":"array","description":"Node capability results","title":"Node capability results"}}},"LogicalRouterConfig":{"x-vmw-nsx-module":"LogicalRouter","type":"object","description":"Logical router configuration parameters.","properties":{"internal_transit_network":{"description":"CIDR block defining service router to distributed router links.\nIf the value for this field is not provided, then it will be\nconsidered as default IPv4 CIDR-\n\"169.254.0.0/28\" for logical router with ACTIVE_STANDBY HA mode\n\"169.254.0.0/24\" for logical router with ACTIVE_ACTIVE HA mode\n","format":"ipv4-cidr-block","type":"string"},"transport_zone_id":{"type":"string","description":"Transport zone of the logical router. If specified then all downlink switches should belong to this transport zone and an error will be thrown if transport zone of the downlink switch doesn't match with this transport zone. All internal and external transit switches will be created in this transport zone.","title":"Transport Zone Identifier"},"ha_vip_configs":{"items":{"$ref":"#/definitions/HaVipConfig"},"type":"array","description":"This configuration can be defined only for Active-Standby LogicalRouter to provide | redundancy. For mulitple uplink ports, multiple HaVipConfigs must be defined | and each config will pair exactly two uplink ports. The VIP will move and will | always be owned by the Active node. Note - when HaVipConfig[s] are defined, | configuring dynamic-routing is disallowed.","title":"Array of HA VIP Config."},"external_transit_networks":{"items":{"description":"IPv4 or IPv6 CIDR Block","format":"ip-cidr-block","type":"string"},"type":"array","description":"CIDR block defining addresses for Tier0 to Tier1 links.\nIf the value for this field is not provided, then it will be\nconsidered as default IPv4 CIDR \"100.64.0.0/16\"\n","title":"CIDR block defining Tier0 to Tier1 links"}},"title":"Logical router config"},"EdgeClusterStatus":{"x-vmw-nsx-module":"AggSvcEdgeCluster","required":["edge_cluster_status","edge_cluster_id"],"type":"object","properties":{"last_update_timestamp":{"description":"Timestamp when the cluster status was last updated","format":"int64","readOnly":true,"type":"integer"},"edge_cluster_status":{"enum":["UP","DOWN","DEGRADED","UNKNOWN"],"type":"string","description":"Status of an edge node","title":"Status of an edge node"},"member_status":{"description":"Per Edge Node Status","title":"Per Edge Node Status","items":{"$ref":"#/definitions/EdgeClusterMemberStatus"},"readOnly":true,"additionalProperties":false,"type":"array"},"edge_cluster_id":{"type":"string","description":"Id of the edge cluster whose status is being reported","title":"Edge cluster id"}}},"LbJwtPublicKey":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/LbJwtKey"},{"required":["public_key_content"],"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"public_key_content":{"type":"string","description":"Content of public key","title":"Content of public key"}}}],"description":"The key is used to specify the public key content which is used to verify\nthe signature of JWT tokens.\n","title":"Specifies public key content used to verify the signature of JWT tokens"},"NodeVersion":{"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"product_version":{"readOnly":true,"type":"string","description":"Product version","title":"Product version"},"node_version":{"readOnly":true,"type":"string","description":"Node version","title":"Node version"}}},"ContainerClusterNodeListResult":{"x-vmw-nsx-module":"InventoryContainerObj","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"InventoryContainerObj","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/ContainerClusterNode"},"type":"array","description":"List of container cluster nodes","title":"List of container cluster nodes"}}}]},"PacketData":{"discriminator":"resource_type","x-vmw-nsx-module":"Traceflow","required":["resource_type"],"type":"object","properties":{"routed":{"type":"boolean","description":"A flag, when set true, indicates that the traceflow packet is of L3 routing.","title":"A flag, when set true, indicates that the traceflow packet is of L3 routing."},"transport_type":{"default":"UNICAST","enum":["BROADCAST","UNICAST","MULTICAST","UNKNOWN"],"type":"string","description":"This type takes effect only for IP packet.","title":"transport type of the traceflow packet"},"resource_type":{"enum":["BinaryPacketData","FieldsPacketData"],"type":"string","description":"Packet configuration","title":"Packet configuration"},"frame_size":{"description":"If the requested frame_size is too small (given the payload and traceflow metadata requirement of 16 bytes), the traceflow request will fail with an appropriate message. The frame will be zero padded to the requested size.","title":"Requested total size of the (logical) packet in bytes","default":128,"format":"int64","maximum":1000,"minimum":60,"type":"integer"}}},"VtepTableCsvRecord":{"x-vmw-nsx-module":"AggSvcLogicalSwitch","allOf":[{"$ref":"#/definitions/CsvRecord"},{"x-vmw-nsx-module":"AggSvcLogicalSwitch","required":["vtep_label","vtep_mac_address"],"type":"object","properties":{"vtep_label":{"format":"int64","type":"integer","description":"The virtual tunnel endpoint label","title":"The virtual tunnel endpoint label"},"vtep_mac_address":{"type":"string","description":"The virtual tunnel endpoint MAC address","title":"The virtual tunnel endpoint MAC address"},"vtep_ip":{"description":"The virtual tunnel endpoint IP address","format":"ip","type":"string"},"segment_id":{"type":"string","description":"The segment Id","title":"The segment Id"}}}]},"LogicalRouterPortStatisticsSummary":{"x-vmw-nsx-module":"AggSvcLogicalRouterPort","allOf":[{"$ref":"#/definitions/AggregatedLogicalRouterPortCounters"},{"x-vmw-nsx-module":"AggSvcLogicalRouterPort","required":["logical_router_port_id"],"type":"object","properties":{"logical_router_port_id":{"type":"string","description":"The ID of the logical router port","title":"The ID of the logical router port"}}}]},"ConditionalForwarderZone":{"x-vmw-nsx-module":"DnsForwarder","allOf":[{"$ref":"#/definitions/ForwarderZone"},{"x-vmw-nsx-module":"DnsForwarder","required":["domain_names"],"type":"object","properties":{"domain_names":{"description":"A forwarder domain name should be a valid FQDN. If reverse lookup is\nneeded for this zone, reverse lookup domain name like X.in-addr.arpa\ncan be defined. Here the X represents a subnet.\n","title":"Domain names of a forwarder zone","minItems":1,"items":{"type":"string"},"maxItems":100,"type":"array"}}}]},"BfdHealthMonitoringProfile":{"x-vmw-nsx-module":"BfdHealthMonitoringProfile","allOf":[{"$ref":"#/definitions/TransportZoneProfile"},{"required":["enabled"],"x-vmw-nsx-module":"BfdHealthMonitoringProfile","type":"object","properties":{"probe_interval":{"description":"The time interval (in millisec) between probe packets for tunnels between transport nodes.","format":"int64","default":1000,"title":"The time interval (in millisec) between probe packets for tunnels between transport nodes.","minimum":300,"type":"integer"},"latency_enabled":{"type":"boolean","description":"The flag is to turn on/off latency. A POST or PUT request with \"latency_enabled\" true will enable NSX to send the networking latency data to thrid-party monitoring tools like vRNI.","title":"Whether the latency is enabled."},"enabled":{"type":"boolean","description":"Whether the heartbeat is enabled. A POST or PUT request with \"enabled\" false (with no probe intervals) will set (POST) or reset (PUT) the probe_interval to their default value.","title":"Whether the heartbeat is enabled. A POST or PUT request with \"enabled\" false (with no probe intervals) will set (POST) or reset (PUT) the probe_interval to their default value."}}}],"description":"Profile for BFD health monitoring","title":"Profile for BFD health monitoring"},"ResetNodeUserOwnPasswordProperties":{"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"password":{"type":"string","description":"The new password for user","title":"The new password for user"},"old_password":{"type":"string","description":"If the old_password is not given, a 400 BAD REQUEST is returned with an error message.","title":"The old password of the user"}}},"LbHttpResponseHeaderCondition":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/LbRuleCondition"},{"required":["header_value","header_name"],"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"header_value":{"type":"string","description":"Value of HTTP header field","title":"Value of HTTP header field"},"case_sensitive":{"default":true,"type":"boolean","description":"If true, case is significant when comparing HTTP header value.\n","title":"A case sensitive flag for HTTP header value comparing"},"match_type":{"description":"Match type of HTTP header value","default":"REGEX","enum":["STARTS_WITH","ENDS_WITH","EQUALS","CONTAINS","REGEX"],"type":"string"},"header_name":{"type":"string","description":"Name of HTTP header field","title":"Name of HTTP header field"}}}],"description":"This condition is used to match HTTP response messages from backend servers\nby HTTP header fields. HTTP header fields are components of the header\nsection of HTTP request and response messages. They define the operating\nparameters of an HTTP transaction. For example, Cookie, Authorization,\nUser-Agent, etc. One condition can be used to match one header field, to\nmatch multiple header fields, multiple conditions must be specified.\nThe match_type field defines how header_value field is used to match HTTP\nresponses. The header_name field does not support match types.\n","title":"Condition to match a header field of HTTP response"},"EdgeClusterMemberAllocationPool":{"discriminator":"allocation_pool_type","x-vmw-nsx-module":"LogicalRouter","required":["allocation_pool_type"],"type":"object","properties":{"allocation_pool_type":{"description":"Types of logical router allocation pool based on services","enum":["LoadBalancerAllocationPool"],"type":"string"}}},"PortConnectionHypervisor":{"x-vmw-nsx-module":"PortConnection","allOf":[{"$ref":"#/definitions/PortConnectionEntity"},{"x-vmw-nsx-module":"PortConnection","type":"object","properties":{"pnics":{"items":{"$ref":"#/definitions/Pnic"},"type":"array","x-deprecated":true},"pnics_list":{"items":{"$ref":"#/definitions/NodeInterfaceProperties"},"type":"array"},"neighbors_list":{"items":{"$ref":"#/definitions/InterfaceNeighborProperties"},"type":"array"},"profiles":{"items":{"$ref":"#/definitions/BaseHostSwitchProfile"},"type":"array"}}}],"description":"Port Connection Hypervisor/Transport Node Entity","title":"Port Connection Hypervisor/Transport Node Entity"},"ControlConnStatus":{"x-vmw-nsx-module":"FabricNode","type":"object","properties":{"status":{"readOnly":true,"enum":["UP","DOWN"],"type":"string","description":"Status of the control Node for e.g UP, DOWN.","title":"Status of the control Node for e.g UP, DOWN."},"control_node_ip":{"readOnly":true,"type":"string","description":"IP address of the control Node.","title":"IP address of the control Node."},"failure_status":{"readOnly":true,"enum":["CONNECTION_REFUSED","INCOMPLETE_HOST_CERT","INCOMPLETE_CONTROLLER_CERT","CONTROLLER_REJECTED_HOST_CERT","HOST_REJECTED_CONTROLLER_CERT","KEEP_ALIVE_TIMEOUT","OTHER_SSL_ERROR","OTHER_ERROR"],"type":"string","description":"Failure status of the control Node for e.g CONNECTION_REFUSED,INCOMPLETE_HOST_CERT.","title":"Failure status of the control Node for e.g CONNECTION_REFUSED,INCOMPLETE_HOST_CERT."}}},"AcceptableComponentVersion":{"x-vmw-nsx-module":"VersionWhitelist","allOf":[{"$ref":"#/definitions/VersionList"},{"x-vmw-nsx-module":"VersionWhitelist","required":["component_type"],"type":"object","properties":{"component_type":{"enum":["HOST","EDGE","CCP","MP"],"type":"string","description":"Node type","title":"Node type"}}}]},"DhcpOption121":{"description":"DHCP option 121 to define classless static route.","title":"DHCP option 121","required":["static_routes"],"x-vmw-nsx-module":"Dhcp","type":"object","properties":{"static_routes":{"description":"Classless static route of DHCP option 121.","title":"DHCP classless static routes","minItems":1,"items":{"$ref":"#/definitions/ClasslessStaticRoute"},"maxItems":27,"type":"array"}}},"Filter":{"x-vmw-nsx-module":"AggSvcL2Types","required":["name","value"],"type":"object","properties":{"name":{"type":"string","description":"The name of the filter.","title":"The name of the filter."},"value":{"type":"string","description":"The value of the filter.","title":"The value of the filter."}}},"GeneralSecuritySettingsProfile":{"x-vmw-nsx-module":"FirewallProfile","allOf":[{"$ref":"#/definitions/BaseFirewallProfile"},{"x-vmw-nsx-module":"FirewallProfile","type":"object","properties":{"enable_double_flow":{"default":false,"readOnly":false,"type":"boolean","description":"The flag to indicate double flow check is enabled or not. This option applies only to EDGE components.","title":"Flag to indicate double flow check is enabled or not"}}}],"description":"A profile holding general security settings.","title":"General security settings profile"},"Attribute":{"description":"Attribute specific to a partner. There attributes are passed on to the partner appliance and is opaque to the NSX Manager. The Attributes used by the partner applicance.","title":"Attributes","required":["key"],"x-vmw-nsx-module":"ServiceInsertionCommonTypes","type":"object","properties":{"read_only":{"default":false,"readOnly":false,"type":"boolean","description":"Read only Attribute cannot be overdidden by service instance/deployment.","title":"read only"},"attribute_type":{"readOnly":false,"enum":["IP_ADDRESS","PORT","PASSWORD","STRING","LONG","BOOLEAN"],"type":"string","description":"Attribute Type can be of any of the allowed enum type.","title":"Attributetype."},"display_name":{"readOnly":false,"type":"string","description":"Attribute display name string value.","title":"Display name"},"value":{"readOnly":false,"type":"string","description":"Attribute value string value.","title":"value"},"key":{"readOnly":false,"type":"string","description":"Attribute key string value.","title":"key"}}},"MirrorSource":{"discriminator":"resource_type","x-vmw-nsx-module":"PortMirroring","required":["resource_type"],"type":"object","properties":{"resource_type":{"description":"Resource types of mirror source","enum":["LogicalPortMirrorSource","PnicMirrorSource","VlanMirrorSource","LogicalSwitchMirrorSource"],"type":"string"}}},"DiscoveredResource":{"x-vmw-nsx-module":"Common","allOf":[{"$ref":"#/definitions/Resource"},{"required":["resource_type"],"discriminator":"resource_type","x-vmw-nsx-module":"Common","type":"object","properties":{"display_name":{"maxLength":255,"type":"string","description":"Defaults to ID if not set","title":"Identifier to use when displaying entity in logs or GUI"},"description":{"maxLength":1024,"type":"string","description":"Description of this resource","title":"Description of this resource"},"_last_sync_time":{"description":"Timestamp of last modification","format":"int64","readOnly":true,"type":"integer"},"tags":{"items":{"$ref":"#/definitions/Tag"},"type":"array","description":"Opaque identifiers meaningful to the API user","maxItems":30,"title":"Opaque identifiers meaningful to the API user"},"scope":{"items":{"$ref":"#/definitions/DiscoveredResourceScope"},"readOnly":false,"type":"array","description":"Specifies list of scope of discovered resource. e.g. if VHC path is associated with\nprincipal identity, who owns the discovered resource, then scope id will be VHC path\nand scope type will be VHC.\n","title":"List of scopes for discovered resource"},"resource_type":{"readOnly":false,"type":"string","description":"The type of this resource."}}}],"description":"Base class for resources that are discovered and automatically updated","title":"Base class for resources that are discovered and automatically updated"},"LogicalSwitchStateListResult":{"x-vmw-nsx-module":"LogicalSwitch","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"LogicalSwitch","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/LogicalSwitchState"},"readOnly":true,"type":"array","description":"Logical Switch State Results","title":"Logical Switch State Results"}}}],"description":"Logical Switch state queries result","title":"Logical Switch state queries result"},"LbServiceInstanceDetailPerStatus":{"x-vmw-nsx-module":"AggSvcLb","type":"object","properties":{"status":{"description":"The type of load balancer instance status.\n","enum":["READY","CONFLICT","NOT_READY"],"type":"string"},"instance_number":{"format":"int64","type":"integer","description":"It means the total number of instances in this status type for the\ngiven transport node.\n","title":"The number of instances in this status type"},"instance_details":{"items":{"$ref":"#/definitions/LbServiceInstanceDetail"},"type":"array","description":"The detailed information of the load balancer instance. This field\nwill be only returned on realtime status API.\n","title":"The detail information of load balancer instance"}}},"RouteMap":{"x-vmw-nsx-module":"Routing","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"Routing","required":["sequences"],"type":"object","properties":{"logical_router_id":{"readOnly":true,"type":"string","description":"Logical router id","title":"Logical router id"},"sequences":{"description":"Ordered list of routeMap sequences","title":"Ordered list of routeMap sequences","minItems":1,"items":{"$ref":"#/definitions/RouteMapSequence"},"maxItems":1000,"type":"array"}}}]},"NodeProcessProperties":{"x-vmw-nsx-module":"MISSING_MODULE","allOf":[{"$ref":"#/definitions/Resource"},{"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"mem_used":{"readOnly":true,"format":"int64","type":"integer","description":"Virtual memory used by process in bytes","title":"Virtual memory used by process in bytes"},"cpu_time":{"readOnly":true,"format":"int64","type":"integer","description":"CPU time (user and system) consumed by process in milliseconds","title":"CPU time (user and system) consumed by process in milliseconds"},"ppid":{"readOnly":true,"format":"int64","type":"integer","description":"Parent process id","title":"Parent process id"},"start_time":{"description":"Process start time expressed in milliseconds since epoch","format":"int64","readOnly":true,"type":"integer"},"process_name":{"readOnly":true,"type":"string","description":"Process name","title":"Process name"},"pid":{"readOnly":true,"format":"int64","type":"integer","description":"Process id","title":"Process id"},"uptime":{"readOnly":true,"format":"int64","type":"integer","description":"Milliseconds since process started","title":"Milliseconds since process started"},"mem_resident":{"readOnly":true,"format":"int64","type":"integer","description":"Resident set size of process in bytes","title":"Resident set size of process in bytes"}}}],"description":"Node process properties","title":"Node process properties"},"MigrationUnitGroupStatusListResult":{"x-vmw-nsx-module":"Migration","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"Migration","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/MigrationUnitGroupStatus"},"readOnly":true,"type":"array","description":"Paged collection of migration status for migration unit groups","title":"Paged collection of migration status for migration unit groups"}}}]},"EdgeNode":{"x-vmw-nsx-module":"FabricNode","allOf":[{"$ref":"#/definitions/Node"},{"x-vmw-nsx-module":"FabricNode","required":["node_settings"],"type":"object","properties":{"node_settings":{"$ref":"#/definitions/EdgeNodeSettings"},"deployment_config":{"$ref":"#/definitions/EdgeNodeDeploymentConfig"},"allocation_list":{"items":{"type":"string"},"readOnly":true,"type":"array","description":"List of logical router ids to which this edge node is allocated.","title":"Allocation list"},"deployment_type":{"description":"Supported edge deployment type.","enum":["VIRTUAL_MACHINE","PHYSICAL_MACHINE","UNKNOWN"],"readOnly":true,"type":"string"}}}]},"IPSecVPNService":{"x-vmw-nsx-module":"IPSecVPN","allOf":[{"$ref":"#/definitions/ManagedResource"},{"required":["logical_router_id"],"x-vmw-nsx-module":"IPSecVPN","type":"object","properties":{"ike_log_level":{"default":"INFO","enum":["DEBUG","INFO","WARN","ERROR","EMERGENCY"],"type":"string","description":"Log level for internet key exchange (IKE).","title":"Internet key exchange (IKE) log level"},"logical_router_id":{"type":"string","description":"Logical router id.","title":"Logical router id"},"ipsec_ha_sync":{"default":true,"type":"boolean","description":"Enable/disable IPSec HA state sync. IPSec HA state sync\ncan be disabled in case there are performance issues with\nthe state sync messages. Default is to enable HA Sync.\n","title":"IPSec HA State Sync flag"},"bypass_rules":{"items":{"$ref":"#/definitions/IPSecVPNPolicyRule"},"type":"array","description":"Bypass policy rules are configured using VPN service.\nBypass rules always have higher priority over protect\nrules and they affect all policy based vpn sessions associated\nwith the IPSec VPN service. Protect rules are defined per\npolicy based vpn session.\n","title":"Bypass Policy rules"},"enabled":{"default":true,"type":"boolean","description":"If true, enable VPN services for given logical router.","title":"Enable virtual private network (VPN) service"}}}],"description":"Create and manage IPSec VPN service for given logical router.","title":"IPSec VPN service"},"SHAPredefinedPluginProfileData":{"x-vmw-nsx-module":"SystemHealthAgent","type":"object","description":"Describes a config item for System Health profile.\n","properties":{"report_interval":{"format":"int64","type":"integer","description":"The interval of plugin to report the status.","title":"The report interval"},"check_interval":{"format":"int64","type":"integer","description":"The interval of plugin to check the status.","title":"The check interval"},"smallest_report_interval_if_change":{"format":"int64","type":"integer","description":"The smallest report interval if the status is changed.\nThe value of smallest_report_interval_if_change should be\nless than the value of report_interval\n","title":"The smallest report interval"}},"title":"System Health Config Item"},"AllocationIpAddressListResult":{"x-vmw-nsx-module":"Ipam","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"Ipam","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/AllocationIpAddress"},"type":"array","description":"Pool allocation list results","title":"Pool allocation list results"}}}]},"ServiceChainMappingListResult":{"x-vmw-nsx-module":"ServiceInsertion","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"ServiceInsertion","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/ServiceChainMapping"},"readOnly":true,"type":"array","description":"List of the Service Chain Mappings. The list has to be homogenous.","title":"Service Chain Mapping List"}}}],"description":"Service Chain Mapping List","title":"Service Chain Mapping List"},"ClusterGroupServiceLeader":{"x-vmw-nsx-module":"Cluster","type":"object","description":"Each cluster node entity provides multiple services. When working in a group, each service can elect a cluster node entity to be the leader of the service. Leader election helps in coordination of the service. The leader holds a renewable lease on the leadership for a fixed period of time. The lease version is incremented every time the leadership lease is renewed. This type contains the attributes of a leader.","properties":{"service_name":{"readOnly":true,"type":"string","description":"Name of the service","title":"Name of the service"},"lease_version":{"readOnly":true,"format":"int64","type":"integer","description":"Number of times the lease has been renewed","title":"Number of times the lease has been renewed"},"leader_uuid":{"readOnly":true,"type":"string","description":"Member UUID of the leader","title":"Member UUID of the leader"}},"title":"Leader for a service of the group"},"TelemetryConfig":{"x-vmw-nsx-module":"TelemetryConfig","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"TelemetryConfig","required":["schedule_enabled","ceip_acceptance"],"type":"object","properties":{"telemetry_deployment_id":{"readOnly":true,"type":"string","description":"Deployment id generated during initialization of telemetry config.","title":"Deployment id associated with telemetry data"},"schedule_enabled":{"type":"boolean","description":"Enable this to schedule data collection and upload times. If enabled,\nand a schedule is not provided, a default schedule (WEEKLY, Sunday at 2:00 a.m)\nwill be applied.\n","title":"Flag to indicate if data collection is enabled"},"ceip_acceptance":{"type":"boolean","description":"Enable this flag to participate in the Customer Experience Improvement Program.\n","title":"Flag to indicate if CEIP has been accepted"},"telemetry_proxy":{"$ref":"#/definitions/TelemetryProxy"},"telemetry_schedule":{"$ref":"#/definitions/TelemetrySchedule"},"proxy_enabled":{"default":false,"type":"boolean","description":"Enable this flag to specify a proxy, and provide the proxy settings.","title":"Flag to indicate if proxy has been configured"}}}]},"Proxy":{"x-vmw-nsx-module":"ProxyConfig","allOf":[{"$ref":"#/definitions/ManagedResource"},{"required":["host","scheme","enabled","port"],"x-vmw-nsx-module":"ProxyConfig","type":"object","properties":{"username":{"type":"string","description":"Specify the user name used to authenticate with the proxy server, if required.\n","title":"User name"},"host":{"format":"hostname-or-ip","type":"string","description":"Specify the fully qualified domain name, or ip address, of the proxy server.\n","title":"FQDN or IP address of the proxy server"},"password":{"type":"string","description":"Specify the password used to authenticate with the proxy server, if required.\n","title":"Password"},"scheme":{"enum":["HTTP","HTTPS"],"type":"string","description":"The scheme accepted by the proxy server. Specify one of HTTP and HTTPS.\n","title":"The scheme accepted by the proxy server"},"enabled":{"type":"boolean","description":"Flag to indicate if proxy is enabled. When set to true, a scheme, host\nand port must be provided.\n","title":"Flag to indicate if proxy is enabled."},"port":{"description":"Specify the port of the proxy server.","format":"int32","title":"Configured port for proxy","maximum":65535,"minimum":0,"type":"integer"}}}],"description":"Type to define the Proxy configuration.","title":"Proxy Configuration"},"FirewallFloodProtectionProfile":{"x-vmw-nsx-module":"FirewallProfile","allOf":[{"$ref":"#/definitions/BaseFirewallProfile"},{"x-vmw-nsx-module":"FirewallProfile","type":"object","properties":{"icmp_active_flow_limit":{"description":"The maximum limit of active icmp connections. If this property is omitted, or set to null, then there is no limit on active icmp connections for those components if it's applied to ESX components (such as segment, segment port, virtual machine, etc); on the other side, if it's applied to EDGE components (such as, gateway), it will be set to default limit (10,000) on the specific components.","title":"Maximum limit of active icmp connections","format":"int64","maximum":1000000,"readOnly":false,"minimum":1,"type":"integer"},"other_active_conn_limit":{"description":"The maximum limit of other active connections besides udp, icmp and half open tcp connections. If this property is omitted, or set to null, then there is no limit on other active connections besides udp, icmp and tcp half open connections for those components if it's applied to ESX components (such as segment, segment port, virtual machine, etc); on the other side, if it's applied to EDGE components (such as, gateway), it will be set to default limit (10,000) on the specific components.","title":"Maximum limit of other active connections besides udp, icmp and tcp half open connections","format":"int64","maximum":1000000,"readOnly":false,"minimum":1,"type":"integer"},"enable_syncache":{"default":false,"readOnly":false,"type":"boolean","description":"The flag to indicate syncache is enabled or not. This option does not apply to EDGE components.","title":"Flag to indicate syncache is enabled or not"},"enable_rst_spoofing":{"default":false,"readOnly":false,"type":"boolean","description":"The flag to indicate RST spoofing is enabled or not. This option does not apply to EDGE components. This can be enabled only if syncache is enabled.","title":"Flag to indicate RST spoofing is enabled or not"},"tcp_half_open_conn_limit":{"description":"The maximum limit of tcp half open connections. If this property is omitted, or set to null, then there is no limit on active tcp half open connections for those components if it's applied to ESX components (such as segment, segment port, virtual machine, etc); on the other side, if it's applied to EDGE components (such as, gateway), it will be set to default limit (1,000,000) on the specific components.","title":"Maximum limit of half open tcp connections","format":"int64","maximum":1000000,"readOnly":false,"minimum":1,"type":"integer"},"udp_active_flow_limit":{"description":"The maximum limit of active udp connections. If this property is omitted, or set to null, then there is no limit on active udp connections for those components if it's applied to ESX components (such as segment, segment port, virtual machine, etc); on the other side, if it's applied to EDGE components (such as, gateway), it will be set to default limit (100,000) on the specific component.","title":"Maximum limit of active udp connections","format":"int64","maximum":1000000,"readOnly":false,"minimum":1,"type":"integer"},"nat_active_conn_limit":{"description":"The maximum limit of active NAT connections. This limit only apply to EDGE components (such as, gateway). If this property is omitted, or set to null, then there is no limit on the specific component. Meanwhile there is an implicit limit which depends on the underlying hardware resource.","title":"Maximum limit of active NAT connections","default":4294967295,"format":"int64","maximum":4294967295,"readOnly":false,"minimum":1,"type":"integer"}}}],"description":"A profile holding protection configuration for SYN flood, UDP flood, ICMP flood and other flood attack.","title":"Firewall flood protection profile"},"EdgeClusterAllocationStatus":{"x-vmw-nsx-module":"EdgeClusters","type":"object","description":"Allocation details of cluster and its members. Contains information of the\nedge nodes present in cluster, active and standby services of each node,\nutilization details of configured sub-pools. These allocation details can\nbe monitored by customers to trigger migration of certain service contexts\nto different edge nodes, to balance the utilization of edge node resources.\n","properties":{"members":{"items":{"$ref":"#/definitions/EdgeMemberAllocationStatus"},"readOnly":true,"type":"array","description":"Allocation details of edge nodes present in the cluster.","title":"Allocation Status of edge nodes"},"display_name":{"readOnly":true,"type":"string","description":"Display name of the edge cluster","title":"Display name of the edge cluster"},"id":{"readOnly":true,"type":"string","description":"System allotted UUID of edge cluster.","title":"Unique identifier of edge cluster"},"member_count":{"readOnly":true,"format":"int32","type":"integer","description":"Represents the number of edge nodes in the cluster.","title":"Count of edge nodes present in the cluster"}},"title":"Allocationd details of edge cluster"},"AutomaticHealthCheck":{"x-vmw-nsx-module":"HealthCheck","type":"object","description":"Health check performed by system automatically on a specific transport zone.\n\nFor overlay based zone, health check is performed on corresponding N-VDS of\neach transport node with the VLAN and MTU specified by uplink profile of\nN-VDS for the node.\n\nFor VLAN based zone, health check is performed on corresponding N-VDS of each\n transport node with MTU specified by uplink profile of N-VDS for the node\n and VLAN specified by all logical switches in this zone.\n","properties":{"transport_zone_id":{"readOnly":true,"type":"string","description":"ID of the transport zone where this automatic health check is performed.\n","title":"Transport Zone ID"},"result":{"$ref":"#/definitions/HealthCheckResult"}},"title":"Automatic Health Check"},"HttpProtocol":{"x-vmw-nsx-module":"MISSING_MODULE","allOf":[{"$ref":"#/definitions/Protocol"},{"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"authentication_scheme":{"$ref":"#/definitions/BasicAuthenticationScheme"}}}]},"EffectiveMemberResourceListResult":{"x-vmw-nsx-module":"NSGroup","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"NSGroup","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/ResourceReference"},"type":"array","description":"Paged Collection of resources which are the effective members of an NSGroup.","title":"Paged Collection of resources which are the effective members of an NSGroup."}}}]},"FileTransferAuthenticationScheme":{"description":"Remote server authentication details","title":"Remote server authentication details","required":["username","scheme_name"],"x-vmw-nsx-module":"BackupConfiguration","type":"object","properties":{"username":{"type":"string","description":"User name to authenticate with","title":"User name to authenticate with"},"scheme_name":{"enum":["PASSWORD"],"type":"string","description":"Authentication scheme name","title":"Authentication scheme name"},"password":{"type":"string","description":"Password to authenticate with","title":"Password to authenticate with"}}},"DonutSection":{"description":"Represents high level logical grouping of portions or segments of a donut / stats chart.","title":"Section of a donut or stats chart","required":["parts"],"x-vmw-nsx-module":"NsxDashboard","type":"object","properties":{"row_list_field":{"maxLength":1024,"type":"string","description":"Field of the root of the api result set for forming parts.","title":"Field from which parts of the donut or stats chart are formed"},"parts":{"minItems":1,"items":{"$ref":"#/definitions/DonutPart"},"type":"array","description":"Array of portions or parts of the donut or stats chart.","title":"Parts of a donut / stats chart"},"template":{"default":false,"type":"boolean","description":"If true, the section will be appled as template for forming parts. Only one part will be formed from each element of 'row_list_field'.","title":"Template, if any, for automatically forming the donut or stats parts"}}},"DhcpIpPoolListResult":{"x-vmw-nsx-module":"Dhcp","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"Dhcp","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/DhcpIpPool"},"type":"array","description":"A paginated list of DHCP ip pools.","title":"Paginated list of DHCP ip pools"}}}],"description":"A paginated list of DHCP ip pools.","title":"A list of DHCP ip pools"},"IpAssignmentSpec":{"description":"Abstract base type for specification of IPs to be used with host switch virtual tunnel endpoints","title":"Abstract base type for specification of IPs to be used with host switch virtual tunnel endpoints","required":["resource_type"],"discriminator":"resource_type","x-vmw-nsx-module":"TransportNode","type":"object","properties":{"resource_type":{"enum":["StaticIpPoolSpec","StaticIpListSpec","AssignedByDhcp","StaticIpMacListSpec"],"type":"string"}}},"IdfwComputeCollectionListResult":{"x-vmw-nsx-module":"IdentityFirewall","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"IdentityFirewall","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/IdfwComputeCollectionStatus"},"type":"array","description":"Array of IDFW compute collection Ids and status connected to VC.","title":"List of IDFW ComputeCollection."}}}],"description":"List of compute collection ids and status connected to VC.","title":"List of IDFW enabled compute collections connected to VC"},"NodeEntityInfo":{"x-vmw-nsx-module":"ClusterManagement","type":"object","properties":{"ip_address":{"type":"string","description":"IP address of service provider","title":"IP address of service provider"},"port":{"description":"Port number of service provider","format":"int64","title":"Port number of service provider","maximum":65535,"minimum":0,"type":"integer"},"entity_type":{"description":"Entity type of this service endpoint","enum":["HTTP","DATASTORE","MANAGER","POLICY","CONTROLLER"],"type":"string"}}},"RoleListResult":{"x-vmw-nsx-module":"AAA","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"AAA","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/Role"},"type":"array","description":"List results","title":"List results"}}}]},"NodeMessagingClientInfo":{"x-vmw-nsx-module":"ClusterManagement","type":"object","properties":{"clients":{"items":{"$ref":"#/definitions/MessagingClientInfo"},"type":"array","description":"A list of messaging clients owned by this entity","title":"A list of messaging clients owned by this entity"},"entity_type":{"description":"Entity type of this messaging client","enum":["HTTP","DATASTORE","MANAGER","POLICY","CONTROLLER"],"type":"string"}}},"VirtualSwitchListResult":{"x-vmw-nsx-module":"InventoryCmObj","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"InventoryCmObj","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/VirtualSwitch"},"type":"array","description":"Virtual switch list results","title":"Virtual switch list results"}}}],"description":"Virtual switch list result","title":"Virtual switch list result"},"MacLearningSpec":{"description":"MAC learning configuration","title":"MAC learning configuration","required":["enabled"],"x-vmw-nsx-module":"MacManagementSwitchingProfile","type":"object","properties":{"limit":{"description":"This property specifies the limit on the maximum number of MAC\naddresses that can be learned on a port. It is consumed by vswitch\nkernel module on the hypervisor while learning MACs per port for\nVMs that are local to the host.\n","title":"The maximum number of MAC addresses that can be learned on this port","default":4096,"format":"int32","maximum":4096,"readOnly":false,"minimum":0,"type":"integer"},"limit_policy":{"description":"The policy after MAC Limit is exceeded","title":"The policy after MAC Limit is exceeded","default":"ALLOW","enum":["ALLOW","DROP"],"readOnly":false,"type":"string"},"remote_overlay_mac_limit":{"description":"This property specifies the limit on the maximum number of MACs\nlearned for a remote Virtual Machine's MAC to vtep binding per\noverlay logical switch.\n","title":"The maximum number of MAC addresses learned on an overlay Logical Switch","default":2048,"format":"int32","maximum":8192,"readOnly":false,"minimum":2048,"type":"integer"},"aging_time":{"description":"Aging time in sec for learned MAC address","format":"int32","default":600,"title":"Aging time in sec for learned MAC address","readOnly":true,"type":"integer"},"enabled":{"readOnly":false,"type":"boolean","description":"Allowing source MAC address learning","title":"Allowing source MAC address learning"},"unicast_flooding_allowed":{"default":true,"readOnly":false,"type":"boolean","description":"Allowing flooding for unlearned MAC for ingress traffic","title":"Allowing flooding for unlearned MAC for ingress traffic"}}},"PortConnectionBMEntities":{"x-vmw-nsx-module":"PortConnection","type":"object","description":"Port Connection Bare Metal Entities","properties":{"src_port":{"$ref":"#/definitions/LogicalPort"},"dst_port":{"$ref":"#/definitions/LogicalPort"}},"title":"Port Connection Bare Metal Entities"},"LbJwtCertificateKey":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/LbJwtKey"},{"required":["certificate_id"],"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"certificate_id":{"type":"string","description":"Certificate identifier","title":"Certificate identifier"}}}],"description":"The key is used to specify certificate which is used to verify the\nsignature of JWT tokens.\n","title":"Specifies certificate used to verify the signature of JWT tokens"},"ClusterRestoreStatus":{"x-vmw-nsx-module":"ClusterRestore","type":"object","description":"Cluster restore status","properties":{"status":{"$ref":"#/definitions/GlobalRestoreStatus"},"step":{"$ref":"#/definitions/RestoreStep"},"endpoints":{"items":{"$ref":"#/definitions/ResourceLink"},"readOnly":true,"type":"array","description":"The list of allowed endpoints, based on the current state of\nthe restore process\n","title":"The list of allowed endpoints, based on the current state of\nthe restore process\n"},"total_steps":{"readOnly":true,"format":"int64","type":"integer","description":"Total number of steps in the entire restore process","title":"Total number of steps in the entire restore process"},"restore_start_time":{"description":"Timestamp when restore was started in epoch millisecond","format":"int64","readOnly":true,"type":"integer"},"restore_end_time":{"description":"Timestamp when restore was completed in epoch millisecond","format":"int64","readOnly":true,"type":"integer"},"not_allowed_actions":{"description":"List of actions that are not allowed","title":"List of actions that are not allowed","default":[],"items":{"enum":["VC_UPDATES"],"type":"string"},"readOnly":true,"uniqueItems":true,"type":"array"},"backup_timestamp":{"description":"Timestamp when backup was initiated in epoch millisecond","format":"int64","readOnly":true,"type":"integer"},"id":{"readOnly":true,"type":"string","description":"Unique id for backup request","title":"Unique id for backup request"},"instructions":{"items":{"$ref":"#/definitions/InstructionInfo"},"readOnly":true,"type":"array","description":"Instructions for users to reconcile Restore operations","title":"Instructions for users to reconcile Restore operations"}},"title":"Cluster restore status"},"OwnerResourceLink":{"x-vmw-nsx-module":"Common","allOf":[{"$ref":"#/definitions/ResourceLink"},{"x-vmw-nsx-module":"Common","type":"object"}],"description":"The server will populate this field when returing the resource. Ignored on PUT and POST.","title":"Link to this resource"},"UpdateOidcEndPointThumbprintRequest":{"x-vmw-nsx-module":"CertificateManager","allOf":[{"$ref":"#/definitions/ManagedResource"},{"required":["oidc_uri","thumbprint"],"x-vmw-nsx-module":"CertificateManager","type":"object","properties":{"oidc_uri":{"readOnly":false,"maxLength":255,"type":"string","description":"URI where to download the meta-data of the OIDC end-point.","title":"OpenID Connect end-point URI"},"thumbprint":{"readOnly":false,"type":"string","description":"Thumbprint of the OIDC URI to make an SSL connection.","title":"Thumbprint"}}}],"description":"Request to update the thumbprint of an OpenID Connect end-point with a new thumbprint.\n","title":"Request to update the thumbprint of an OpenId Connect end-point"},"BatchRequest":{"x-vmw-nsx-module":"Common","type":"object","description":"A set of operations to be performed in a single batch","properties":{"requests":{"items":{"$ref":"#/definitions/BatchRequestItem"},"type":"array"},"continue_on_error":{"default":true,"type":"boolean","description":"Continue even if an error is encountered."}},"title":"A set of operations to be performed in a single batch"},"ServiceDeploymentSpec":{"description":"ServiceDeployment Spec consists of information required to deploy and configure the partner appliances. viz. Deployment template, deployment spec and NIC metatdata.","title":"Service Deployment Specification.","required":["deployment_template"],"x-vmw-nsx-module":"ServiceInsertionCommonTypes","type":"object","properties":{"deployment_specs":{"description":"Deployment Specs holds information required to deploy the Service-VMs. i.e. OVF url where the partner Service-VM OVF is hosted. The host type on which the OVF can be deployed, Form factor to name a few.","title":"Service Deployment Spec List","items":{"$ref":"#/definitions/SVMDeploymentSpec"},"readOnly":false,"maxItems":128,"type":"array"},"nic_metadata_list":{"items":{"$ref":"#/definitions/NicMetadata"},"readOnly":false,"type":"array","description":"NIC metadata associated with the deployment spec.","title":"NIC Metadata"},"deployment_template":{"items":{"$ref":"#/definitions/DeploymentTemplate"},"readOnly":false,"type":"array","description":"Deployment Template holds the attributes specific to partner for which the service is created. These attributes are opaque to NSX Manager.","title":"Service Deployment Template"},"svm_version":{"type":"string","description":"Partner needs to specify the Service VM version which will get deployed.","title":"Partner Service-VM version."}}},"NvdsUpgradeTopology":{"x-vmw-nsx-module":"NvdsUpgradeReadinessCheck","allOf":[{"$ref":"#/definitions/ManagedResource"},{"required":["nvds_id","nvds_name","compute_manager_topology"],"x-vmw-nsx-module":"NvdsUpgradeReadinessCheck","type":"object","properties":{"nvds_id":{"type":"string","description":"Identifier for a NVDS","title":"Identifier for a NVDS"},"nvds_name":{"type":"string","description":"Name of a NVDS","title":"Name of a NVDS"},"compute_manager_topology":{"items":{"$ref":"#/definitions/ComputeManagerTopology"},"type":"array","description":"All resultant VDS mapping for a NVDS after the migration","title":"All resultant VDS mapping for a NVDS after the migration"}}}],"description":"NVDS to VDS mappings for migration","title":"NVDS to VDS mappings for migration"},"NicInfo":{"x-vmw-nsx-module":"ServiceInsertionCommonTypes","type":"object","description":"Information of a network interface present on the partner appliance that needs to be configured by the NSX Manager.","properties":{"subnet_mask":{"readOnly":false,"type":"string","description":"Subnet mask associated with the NIC metadata.","title":"Subnet mask"},"gateway_address":{"readOnly":false,"type":"string","description":"Gateway address associated with the NIC metadata.","title":"Gateway address"},"ip_allocation_type":{"readOnly":false,"enum":["STATIC","DHCP","NONE"],"type":"string","description":"IP allocation type with values STATIC, DHCP, or NONE indicating that IP address is not required.","title":"IP allocation type"},"nic_metadata":{"$ref":"#/definitions/NicMetadata"},"network_id":{"readOnly":false,"type":"string","description":"Network Id associated with the NIC metadata. It can be a moref, or a logical switch ID. If it is to be taken from 'Agent VM Settings', then it should be empty.","title":"Network Id"},"ip_pool_id":{"readOnly":false,"type":"string","description":"If the nic should get IP using a static IP pool then IP pool id should be provided here.","title":"Static IP Pool Id"},"ip_address":{"readOnly":false,"type":"string","description":"IP address associated with the NIC metadata. Required only when assigning IP statically for a deployment that is for a single VM instance.","title":"IP address"}},"title":"NIC information"},"BgpNeighbor":{"x-vmw-nsx-module":"Routing","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"Routing","required":["neighbor_address"],"type":"object","properties":{"graceful_restart_mode":{"description":"BGP Graceful Restart mode. If specified, then it will take precedence\nover global Graceful Restart mode configured in logical router\nBgpConfig otherwise BgpConfig level Graceful Restart mode will be\napplicable for peer.\n","enum":["DISABLE","HELPER_ONLY","GR_AND_HELPER"],"type":"string"},"remote_as":{"description":"This is a deprecated property, Please use 'remote_as_num' instead.","title":"Autonomous System Number of the neighbor","format":"int64","maximum":4294967296,"x-deprecated":true,"minimum":1,"type":"integer"},"filter_out_ipprefixlist_id":{"type":"string","description":"This is a deprecated property, Please use 'address_family' instead.","x-deprecated":true,"title":"IPPrefixList to be used for OUT direction filter for IPV4_UNICAST address family"},"hold_down_timer":{"description":"Wait period (seconds) before declaring peer dead","title":"Wait period (seconds) before declaring peer dead","default":180,"format":"int64","maximum":65535,"minimum":1,"type":"integer"},"source_addresses":{"items":{"description":"IPv4 or IPv6 address","format":"ip","type":"string"},"type":"array","description":"BGP neighborship will be formed from all these source addresses to this neighbour.","maxItems":8,"title":"Array of Logical Router Uplink IP Addresses"},"maximum_hop_limit":{"description":"This value is set on TTL(time to live) of BGP header.\nWhen router receives the BGP packet, it decrements the TTL. The default\nvalue of TTL is one when BPG request is initiated.So in the case of a\nBGP peer multiple hops away and and value of TTL is one, then next\nrouter in the path will decrement the TTL to 0, realize it cant forward\nthe packet and will drop it. If the hop count value to reach neighbor\nis equal to or less than the maximum_hop_limit value then intermediate\nrouter decrements the TTL count by one and forwards the request to\nBGP neighour. If the hop count value is greater than the maximum_hop_limit\nvalue then intermediate router discards the request when TTL becomes 0.\n","title":"Maximum Number of hops allowed to reach BGP neighbor","default":1,"format":"int32","maximum":255,"minimum":1,"type":"integer"},"enabled":{"default":true,"type":"boolean","description":"Flag to enable this BGP Neighbor","title":"Flag to enable this BGP Neighbor"},"remote_as_num":{"type":"string","description":"4 Byte ASN of the neighbor in ASPLAIN/ASDOT Format","title":"4 Byte ASN of the neighbor in ASPLAIN/ASDOT Format"},"address_families":{"items":{"$ref":"#/definitions/BgpNeighborAddressFamily"},"type":"array","description":"User can enable the neighbor for the specific address families and also define filters per address family.\nWhen the neighbor is created, it is default enabled for IPV4_UNICAST address family for backward compatibility reasons.\nUser can change that if required, by defining the address family configuration.\n","title":"AddressFamily settings for the neighbor"},"bfd_config":{"$ref":"#/definitions/BfdConfigParameters"},"logical_router_id":{"readOnly":true,"type":"string","description":"Logical router id","title":"Logical router id"},"filter_in_ipprefixlist_id":{"type":"string","description":"This is a deprecated property, Please use 'address_family' instead.","x-deprecated":true,"title":"IPPrefix List to be used for IN direction filter for IPV4_UNICAST address family"},"filter_out_routemap_id":{"type":"string","description":"This is a deprecated property, Please use 'address_family' instead.","x-deprecated":true,"title":"RouteMap to be used for OUT direction filter for IPV4_UNICAST address family"},"filter_in_routemap_id":{"type":"string","description":"This is a deprecated property, Please use 'address_family' instead.","x-deprecated":true,"title":"RouteMap to be used for IN direction filter for IPV4_UNICAST address family"},"keep_alive_timer":{"description":"Frequency (seconds) with which keep alive messages are sent to peers","title":"Frequency (seconds) with which keep alive messages are sent to peers","default":60,"format":"int64","maximum":65535,"minimum":1,"type":"integer"},"password":{"minLength":1,"type":"string","description":"User can create (POST) the neighbor with or without the password.\nThe view (GET) on the neighbor, would never reveal if the password is set or not.\nThe password can be set later using edit neighbor workFlow (PUT)\nOn the edit neighbor (PUT), if the user does not specify the password property, the\nolder value is retained. Maximum length of this field is 20 characters.\n","title":"Password"},"source_address":{"description":"Deprecated - do not provide a value for this field. Use source_addresses instead.","format":"ip","x-deprecated":true,"type":"string"},"allow_as_in":{"default":false,"type":"boolean","description":"Flag to enable allowas_in option for BGP neighbor","title":"Flag to enable allowas_in option for BGP neighbor"},"enable_bfd":{"default":false,"type":"boolean","description":"Flag to enable BFD for this BGP Neighbor. Enable this if the neighbor supports BFD as this will lead to faster convergence.","title":"Enable BFD for this BGP Neighbor"},"neighbor_address":{"description":"Neighbor IP Address","format":"ip","type":"string"}}}]},"IpfixCollectorUpmProfileListResult":{"x-vmw-nsx-module":"UpmIpfixCollector","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"UpmIpfixCollector","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/IpfixCollectorUpmProfile"},"readOnly":true,"type":"array","description":"IPFIX Collector Profile List","title":"IPFIX Collector Profile List"}}}],"description":"IPFIX collector profile list result for query with profile list parameters\n","title":"List of IPFIX Collector Profiles"},"HealthCheckResultPerTransportNode":{"x-vmw-nsx-module":"HealthCheck","type":"object","description":"Health check result on specific transport node\n","properties":{"result_on_host_switch":{"$ref":"#/definitions/HealthCheckResultOnHostSwitch"},"transport_node_id":{"readOnly":true,"type":"string","description":"ID of the Transport Node.","title":"Transport Node ID"}},"title":"Health Check Result Per Transport Node"},"LbGenericPersistenceProfile":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/LbPersistenceProfile"},{"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"ha_persistence_mirroring_enabled":{"default":false,"type":"boolean","description":"The mirroring enabled flag is to synchronize persistence entries.\nPersistence entries are not synchronized to the HA peer by default.\n","title":"Mirroring enabled flag"},"timeout":{"description":"When all connections complete (reference count reaches 0), persistence\nentry timer is started with the expiration time.\n","title":"Persistence entry expiration time in seconds","default":300,"format":"int64","maximum":2147483647,"minimum":1,"type":"integer"}}}],"description":"The profile is used to define the persistence entry expiration time,\nmirroring enabled flag to synchronize persistence entries, persistence\nshared flag for the associated virtual servers. The profile cannot be\nattached to virtual server directly, it can be only consumed by LB rule\naction. In HTTP forwarding phase, LBVariablePersistenceOnAction can be\nused to consume LbGenericPersistenceProfile. In HTTP response rewriting\nphase, LBVariablePersistenceLearnAction is used instead.\nThe object is deprecated as NSX-T Load Balancer is deprecated.\n","title":"LB generic persistence profile"},"TelemetrySchedule":{"description":"Abstract base type for telemetry schedule configuration","title":"Abstract base type for telemetry schedule configuration","required":["frequency_type"],"discriminator":"frequency_type","x-vmw-nsx-module":"TelemetryConfig","type":"object","properties":{"frequency_type":{"type":"string","description":"Specify one of DailyTelemetrySchedule, WeeklyTelemetrySchedule, or MonthlyTelemetrySchedule.","title":"Frequency at which data will be collected"}}},"ServiceInsertionRuleList":{"description":"List of ServiceInsertion Rules.","title":"ServiceInsertion Section RuleList","required":["rules"],"x-vmw-nsx-module":"ServiceInsertionRules","type":"object","properties":{"rules":{"items":{"$ref":"#/definitions/ServiceInsertionRule"},"type":"array","description":"List of ServiceInsertion rules in the section. Only homogeneous rules are supported.","maxItems":1000,"title":"List of the ServiceInsertion rules"}}},"TransportNodeDeploymentProgressState":{"x-vmw-nsx-module":"TransportNode","type":"object","description":"Deployment progress state of transport node. Object has current deployment step title and progress in percentage.","properties":{"progress":{"readOnly":true,"format":"int64","type":"integer","description":"Percentage of deployment completed","title":"Percentage of deployment completed"},"current_step_title":{"readOnly":true,"type":"string","description":"Deployment step title","title":"Deployment step title"}},"title":"Deployment progress of transport node"},"SupportBundleContainerNode":{"discriminator":"container_type","x-vmw-nsx-module":"MISSING_MODULE","required":["container_type"],"type":"object","properties":{"container_type":{"enum":["ANTREA"],"type":"string","description":"Support bundle container type","title":"Support bundle container type"}}},"TransportZoneEndPoint":{"description":"Specify which HostSwitch from this TransportNode is used handle traffic for given TransportZone","title":"This object associates TransportNode to a certain TransportZone","required":["transport_zone_id"],"x-vmw-nsx-module":"TransportNode","type":"object","properties":{"transport_zone_id":{"type":"string","description":"For MP APIs provide UUID of transport zone. For Policy APIs provide policyPath of transport zone.","title":"Unique ID identifying the transport zone for this endpoint"},"transport_zone_profile_ids":{"items":{"$ref":"#/definitions/TransportZoneProfileTypeIdEntry"},"type":"array","description":"For MP APIs provide UUID of transport zone profiles. For Policy APIs provide policyPath of transport zone profiles.","title":"Identifiers of the transport zone profiles associated with this transport zone endpoint on this transport node."}}},"PoolMemberSetting":{"description":"The setting is used to add, update or remove pool members from pool.\nFor static pool members, admin_state, display_name and weight can be\nupdated.\nFor dynamic pool members, only admin_state can be updated.\n","title":"Pool member setting","required":["ip_address"],"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"admin_state":{"description":"Member admin state","default":"ENABLED","enum":["ENABLED","DISABLED","GRACEFUL_DISABLED"],"type":"string"},"ip_address":{"description":"Pool member IP address","format":"ip","type":"string"},"port":{"description":"Pool member port number","format":"port-or-range","type":"string"},"weight":{"description":"Only applicable to static pool members. If supplied for a pool defined\nby a grouping object, update API would fail.\n","format":"int64","title":"Pool member weight","maximum":255,"minimum":1,"type":"integer"},"display_name":{"type":"string","description":"Only applicable to static pool members. If supplied for a pool defined\nby a grouping object, update API would fail.\n","title":"Pool member display name"}}},"NodeSyslogExporterProperties":{"x-vmw-nsx-module":"MISSING_MODULE","allOf":[{"$ref":"#/definitions/Resource"},{"required":["server","protocol","exporter_name","level"],"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"tls_ca_pem":{"type":"string","description":"CA certificate PEM of TLS server to export to","title":"CA certificate PEM of TLS server to export to"},"protocol":{"enum":["TCP","TLS","UDP","LI","LI-TLS"],"type":"string","description":"Export protocol","title":"Export protocol"},"exporter_name":{"type":"string","description":"Syslog exporter name","title":"Syslog exporter name"},"level":{"enum":["EMERG","ALERT","CRIT","ERR","WARNING","NOTICE","INFO","DEBUG"],"type":"string","description":"Logging level to export","title":"Logging level to export"},"tls_client_ca_pem":{"type":"string","description":"CA certificate PEM of the rsyslog client","title":"CA certificate PEM of the rsyslog client"},"tls_cert_pem":{"type":"string","description":"Certificate PEM of the rsyslog client","title":"Certificate PEM of the rsyslog client"},"server":{"description":"IP address or hostname of server to export to","format":"hostname-or-ipv4","type":"string"},"facilities":{"items":{"description":"Syslog facility","enum":["KERN","USER","MAIL","DAEMON","AUTH","SYSLOG","LPR","NEWS","UUCP","AUTHPRIV","FTP","LOGALERT","CRON","LOCAL0","LOCAL1","LOCAL2","LOCAL3","LOCAL4","LOCAL5","LOCAL6","LOCAL7"],"type":"string"},"type":"array","description":"Facilities to export","title":"Facilities to export"},"msgids":{"items":{"pattern":"/^.+$/","type":"string"},"type":"array","description":"MSGIDs to export","title":"MSGIDs to export"},"structured_data":{"items":{"pattern":"/^(alarmId|alarmState|audit|comp|entId|eReqId|errorCode|eventFeatureName|eventId|eventSev|eventState|eventType|euser|level|nodeId|security|subcomp|s2comp|splitId|splitIndex|tenantId|tid|tname|update|username)=.+$/","type":"string"},"type":"array","description":"Structured data to export","title":"Structured data to export"},"port":{"description":"Port to export to, defaults to 514 for TCP, TLS, UDP protocols or 9000 for LI, LI-TLS protocols","format":"int64","title":"Port to export to, defaults to 514 for TCP, TLS, UDP protocols or 9000 for LI, LI-TLS protocols","maximum":65535,"minimum":1,"type":"integer"},"tls_key_pem":{"type":"string","description":"Private key PEM of the rsyslog client","title":"Private key PEM of the rsyslog client"}}}],"description":"Node syslog exporter properties","title":"Node syslog exporter properties"},"NotificationsList":{"x-vmw-nsx-module":"NfwConfig","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"NfwConfig","type":"object","properties":{"notifications":{"items":{"$ref":"#/definitions/Notification"},"type":"array"}}}]},"LbHttpRequestHeaderRewriteAction":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/LbRuleAction"},{"required":["header_value","header_name"],"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"header_value":{"type":"string","description":"Value of HTTP request header","title":"Value of HTTP request header"},"header_name":{"type":"string","description":"Name of HTTP request header","title":"Name of HTTP request header"}}}],"description":"This action is used to rewrite header fields of matched HTTP request\nmessages to specified new values. One action can be used to rewrite one\nheader field. To rewrite multiple header fields, multiple actions must be\ndefined.\nCaptured variables and built-in variables can be used in the header_value\nfield, header_name field does not support variables.\n","title":"Action to rewrite header fields of HTTP request messages."},"FirewallCpuMemThresholdsProfile":{"x-vmw-nsx-module":"FirewallProfile","allOf":[{"$ref":"#/definitions/BaseFirewallProfile"},{"required":["mem_threshold_percentage","cpu_threshold_percentage"],"x-vmw-nsx-module":"FirewallProfile","type":"object","properties":{"mem_threshold_percentage":{"description":"Heap memory threshold percentage to monitor and report for distributed firewall.","title":"Heap memory threshold utilization percentage","default":90,"format":"int64","maximum":100,"readOnly":false,"minimum":10,"type":"integer"},"cpu_threshold_percentage":{"description":"CPU utilization threshold percentage to monitor and report for distributed firewall.","title":"CPU utilization threshold percentage","default":90,"format":"int64","maximum":100,"readOnly":false,"minimum":10,"type":"integer"}}}],"description":"A profile holding CPU and memory threshold configuration.","title":"Firewall CPU and memory threshold profile"},"StaticRoute":{"x-vmw-nsx-module":"Routing","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"Routing","required":["next_hops","network"],"type":"object","properties":{"next_hops":{"minItems":1,"items":{"$ref":"#/definitions/StaticRouteNextHop"},"type":"array","description":"Next Hops","title":"Next Hops"},"logical_router_id":{"readOnly":true,"type":"string","description":"Logical router id","title":"Logical router id"},"network":{"description":"CIDR","format":"ip-cidr-block","type":"string"}}}]},"AllClusterGroupStatus":{"x-vmw-nsx-module":"Cluster","type":"object","description":"A list of the statuses of all the groups in the cluster.","properties":{"overall_status":{"readOnly":true,"enum":["STABLE","DEGRADED","UNAVAILABLE"],"type":"string","description":"Overall status of the cluster","title":"Overall status of the cluster"},"cluster_id":{"readOnly":true,"type":"string","description":"UUID of the cluster","title":"UUID of the cluster"},"groups":{"items":{"$ref":"#/definitions/ClusterGroupStatus"},"readOnly":true,"type":"array","description":"Array of groups and their statuses","title":"Array of groups and their statuses"}},"title":"Status of all the cluster groups"},"EmbeddedResource":{"x-vmw-nsx-module":"Common","allOf":[{"$ref":"#/definitions/RevisionedResource"},{"x-vmw-nsx-module":"Common","type":"object","properties":{"_owner":{"$ref":"#/definitions/OwnerResourceLink"},"display_name":{"maxLength":255,"type":"string","description":"Defaults to ID if not set","title":"Identifier to use when displaying entity in logs or GUI"},"id":{"readOnly":true,"type":"string","description":"Identifier of the resource"},"resource_type":{"readOnly":false,"type":"string","description":"The type of this resource."},"description":{"maxLength":1024,"type":"string","description":"Description of this resource","title":"Description of this resource"}}}],"description":"Base class for resources that are embedded in other resources","title":"Base class for resources that are embedded in other resources"},"ContainerClusterListResult":{"x-vmw-nsx-module":"InventoryContainerObj","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"InventoryContainerObj","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/ContainerCluster"},"type":"array","description":"List of Container Clusters","title":"List of Container Clusters"}}}]},"MetadataProxyListResult":{"x-vmw-nsx-module":"MetadataProxy","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"MetadataProxy","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/MetadataProxy"},"type":"array","description":"paginated list of metadata proxies","title":"paginated list of metadata proxies"}}}]},"StaticHopBfdPeerListResult":{"x-vmw-nsx-module":"Routing","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"Routing","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/StaticHopBfdPeer"},"readOnly":true,"type":"array","description":"static hop BFD peer list results","title":"static hop BFD peer list results"}}}]},"PrefixConfig":{"x-vmw-nsx-module":"Routing","required":["action"],"type":"object","properties":{"action":{"description":"Action for the IPPrefix","enum":["PERMIT","DENY"],"type":"string"},"ge":{"description":"Greater than or equal to","format":"int64","title":"Greater than or equal to","maximum":128,"minimum":1,"type":"integer"},"le":{"description":"Less than or equal to","format":"int64","title":"Less than or equal to","maximum":128,"minimum":1,"type":"integer"},"network":{"description":"If absent, the action applies to all addresses.","format":"ip-cidr-block","type":"string"}}},"SummaryMigrationFeedbackRequest":{"x-vmw-nsx-module":"Migration","type":"object","description":"Minimal description of feedback requests.","properties":{"resolved":{"readOnly":true,"type":"boolean","description":"Indicates if a valid response already exist for this feedback request.","title":"Indicates if this feedback request has already been resolved"},"v_object_name":{"readOnly":true,"type":"string","description":"Name of this object in the source NSX endpoint.","title":"Name of this object in the source NSX endpoint"},"object_id":{"readOnly":true,"type":"string","description":"Identifier of the object for which feedback is requested.","title":"UUID of the object"},"v_object_id":{"readOnly":true,"type":"string","description":"Identifier for this object in the source NSX endpoint.","title":"Id of this object in the source NSX endpoint"},"federation_site_id":{"readOnly":true,"type":"string","description":"Id of the site in NSX-T Federation","title":"Id of the site in NSX-T Federation"},"resolution":{"readOnly":true,"type":"string","description":"If the feedback request was resolved earlier, provides details about the previous resolution.","title":"Previous resolution details for this feedback request"},"id":{"readOnly":true,"type":"string","description":"Identifier of the feedback request.","title":"UUID of the feedback request"},"rejected":{"readOnly":true,"type":"boolean","description":"Indicates if previous response was invalid. Please provide a valid response.","title":"Indicates if the previous feedback response was rejected"},"details":{"readOnly":true,"type":"string","description":"Details about this specific feedback request.","title":"Details about this specific feedback request"}},"title":"Feedback detail required for Migration"},"FirewallService":{"x-vmw-nsx-module":"Firewall","allOf":[{"$ref":"#/definitions/DSService"},{"x-vmw-nsx-module":"Firewall","type":"object"}]},"DirectoryAdGroup":{"x-vmw-nsx-module":"DirectoryService","allOf":[{"$ref":"#/definitions/DirectoryGroup"},{"x-vmw-nsx-module":"DirectoryService","required":["object_guid","secure_id"],"type":"object","properties":{"object_guid":{"type":"string","description":"GUID is a 128-bit value that is unique not only in the enterprise but also across the world. GUIDs are assigned to every object created by Active Directory, not just User and Group objects.","title":"Active directory group object guid"},"secure_id":{"type":"string","description":"A security identifier (SID) is a unique value of variable length used to identify a trustee. A SID consists of the following components - The revision level of the SID structure; A 48-bit identifier authority value that identifies the authority that issued the SID; A variable number of subauthority or relative identifier (RID) values that uniquely identify the trustee relative to the authority that issued the SID.","title":"Active directory group secure id"}}}]},"NodeFileSystemProperties":{"x-vmw-nsx-module":"ApplianceStats","type":"object","description":"File system properties","properties":{"mount":{"readOnly":true,"type":"string","description":"File system mount","title":"File system mount"},"total":{"readOnly":true,"format":"int64","type":"integer","description":"File system size in kilobytes","title":"File system size in kilobytes"},"type":{"readOnly":true,"type":"string","description":"File system type","title":"File system type"},"file_system":{"readOnly":true,"type":"string","description":"File system id","title":"File system id"},"used":{"readOnly":true,"format":"int64","type":"integer","description":"Amount of file system used in kilobytes","title":"Amount of file system used in kilobytes"}},"title":"File system properties"},"LbHttpsMonitor":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/LbActiveMonitor"},{"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"response_status_codes":{"items":{"type":"integer","format":"int32"},"type":"array","description":"The HTTP response status code should be a valid HTTP status code.\n","maxItems":64,"title":"Array of single HTTP response status codes"},"server_auth_crl_ids":{"items":{"type":"string"},"type":"array","description":"A Certificate Revocation List (CRL) can be specified in the server-side\nSSL profile binding to disallow compromised server certificates.\n","title":"CRL identifier list to verify server certificate"},"server_auth_ca_ids":{"items":{"type":"string"},"type":"array","description":"If server auth type is REQUIRED, server certificate must be signed by\none of the trusted Certificate Authorities (CAs), also referred to as\nroot CAs, whose self signed certificates are specified.\n","title":"CA identifier list to verify server certificate"},"server_auth":{"description":"server authentication mode","default":"IGNORE","enum":["REQUIRED","IGNORE"],"type":"string"},"request_body":{"type":"string","description":"String to send as part of HTTP health check request body. Valid only\nfor certain HTTP methods like POST.\n","title":"String to send as part of HTTP health check request body. Valid only\nfor certain HTTP methods like POST.\n"},"response_body":{"type":"string","description":"If HTTP response body match string (regular expressions not supported)\nis specified (using LbHttpMonitor.response_body) then the\nhealthcheck HTTP response body is matched against the specified string\nand server is considered healthy only if there is a match.\nIf the response body string is not specified, HTTP healthcheck is\nconsidered successful if the HTTP response status code is 2xx, but it\ncan be configured to accept other status codes as successful.\n","title":"response body to match"},"ciphers":{"items":{"description":"SSL cipher","enum":["TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256","TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384","TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA","TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA","TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA","TLS_ECDH_RSA_WITH_AES_256_CBC_SHA","TLS_RSA_WITH_AES_256_CBC_SHA","TLS_RSA_WITH_AES_128_CBC_SHA","TLS_RSA_WITH_3DES_EDE_CBC_SHA","TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA","TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256","TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384","TLS_RSA_WITH_AES_128_CBC_SHA256","TLS_RSA_WITH_AES_128_GCM_SHA256","TLS_RSA_WITH_AES_256_CBC_SHA256","TLS_RSA_WITH_AES_256_GCM_SHA384","TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA","TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256","TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256","TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384","TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384","TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA","TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256","TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256","TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384","TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384","TLS_ECDH_RSA_WITH_AES_128_CBC_SHA","TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256","TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256","TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384","TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384"],"type":"string"},"type":"array","description":"supported SSL cipher list to servers","title":"supported SSL cipher list to servers"},"request_headers":{"items":{"$ref":"#/definitions/LbHttpRequestHeader"},"type":"array","description":"Array of HTTP request headers","title":"Array of HTTP request headers"},"client_certificate_id":{"type":"string","description":"client certificate can be specified to support client authentication.\n","title":"client certificate identifier"},"request_method":{"description":"the health check method for HTTP monitor type","default":"GET","enum":["GET","OPTIONS","POST","HEAD","PUT"],"type":"string"},"is_fips":{"readOnly":true,"type":"boolean","description":"This flag is set to true when all the ciphers and protocols are FIPS\ncompliant. It is set to false when one of the ciphers or protocols are\nnot FIPS compliant..\n","title":"FIPS compliance of ciphers and protocols"},"certificate_chain_depth":{"description":"authentication depth is used to set the verification depth in the server\ncertificates chain.\n","title":"the maximum traversal depth of server certificate chain","default":3,"format":"int64","maximum":2147483647,"minimum":1,"type":"integer"},"is_secure":{"readOnly":true,"type":"boolean","description":"This flag is set to true when all the ciphers and protocols are secure.\nIt is set to false when one of the ciphers or protocols is insecure.\n","title":"Secure/Insecure monitor flag"},"request_url":{"type":"string","description":"URL used for HTTP monitor","title":"URL used for HTTP monitor"},"cipher_group_label":{"description":"It is a label of cipher group which is mostly consumed by GUI.\n","enum":["BALANCED","HIGH_SECURITY","HIGH_COMPATIBILITY","CUSTOM"],"type":"string"},"request_version":{"description":"HTTP request version","default":"HTTP_VERSION_1_1","enum":["HTTP_VERSION_1_0","HTTP_VERSION_1_1"],"type":"string"},"protocols":{"items":{"description":"SSL protocol","enum":["SSL_V2","SSL_V3","TLS_V1","TLS_V1_1","TLS_V1_2"],"type":"string"},"type":"array","description":"SSL versions TLS1.1 and TLS1.2 are supported and enabled by default.\nSSLv2, SSLv3, and TLS1.0 are supported, but disabled by default.\n","title":"supported SSL protocol list to servers"}}}]},"AssociationListResult":{"x-vmw-nsx-module":"Association","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"Association","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/ResourceReference"},"type":"array","description":"Paged Collection of ResourceReference","title":"Paged Collection of ResourceReference"}}}]},"HostSwitchProfilesListResult":{"x-vmw-nsx-module":"BaseHostSwitchProfile","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"BaseHostSwitchProfile","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/BaseHostSwitchProfile"},"readOnly":true,"type":"array","description":"HostSwitch Profile Results","title":"HostSwitch Profile Results"}}}],"description":"HostSwitch Profile queries result","title":"HostSwitch Profile queries result"},"LbServiceUsage":{"x-vmw-nsx-module":"LoadBalancer","type":"object","description":"Describes the capacity and current usage of virtual servers, pools, pool\nmembers for the given load balancer service.\n","properties":{"pool_capacity":{"readOnly":true,"format":"int64","type":"integer","description":"Pool capacity means maximum number of pools which could be configured\nin the given load balancer service.\n","title":"The capacity of pools"},"service_size":{"description":"The size of load balancer service","enum":["SMALL","MEDIUM","LARGE","XLARGE","DLB"],"readOnly":true,"type":"string"},"severity":{"description":"The severity calculation is based on the largest usage percentage from\nvirtual servers, pools, pool members and rules for one load balancer\nservice.\n","enum":["GREEN","ORANGE","RED"],"readOnly":true,"type":"string"},"pool_member_capacity":{"readOnly":true,"format":"int64","type":"integer","description":"Pool member capacity means maximum number of pool members which could\nbe configured in the given load balancer service.\n","title":"The capacity of pool members"},"current_virtual_server_count":{"readOnly":true,"format":"int64","type":"integer","description":"The current number of virtual servers which have been configured in the\ngiven load balancer service.\n","title":"The current number of virtual servers"},"usage_percentage":{"readOnly":true,"type":"number","description":"The usage percentage is the largest usage percentage from virtual\nservers, pools and pool members for the load balancer service. If the\nproperty relax_scale_validation is set as true for LbService, it is\npossible that the value is larger than 100.0. For example, if SMALL LBS\nis deployed on MEDIUM edge node and configured with MEDIUM LBS virtual\nserver scale number, LBS usage percentage is shown larger than 100.0.\n","title":"Usage percentage"},"service_id":{"readOnly":true,"type":"string","description":"UUID of load balancer service","title":"UUID of load balancer service"},"current_pool_count":{"readOnly":true,"format":"int64","type":"integer","description":"The current number of pools which have been configured in the given load\nbalancer service.\n","title":"The current number of pools"},"virtual_server_capacity":{"readOnly":true,"format":"int64","type":"integer","description":"Virtual server capacity means maximum number of virtual servers which\ncould be configured in the given load balancer service.\n","title":"The capacity of virtual servers"},"current_pool_member_count":{"readOnly":true,"format":"int64","type":"integer","description":"The current number of pool members which have been configured in the\ngiven load balancer service.\n","title":"The current number of pool members"}},"title":"The usage information of the load balancer service"},"TransportZoneProfile":{"x-vmw-nsx-module":"TransportZoneProfile","allOf":[{"$ref":"#/definitions/ManagedResource"},{"discriminator":"resource_type","x-vmw-nsx-module":"TransportZoneProfile","required":["resource_type"],"type":"object","properties":{"resource_type":{"enum":["BfdHealthMonitoringProfile"],"type":"string"}}}]},"LbServiceDebugInfo":{"x-vmw-nsx-module":"LoadBalancer","type":"object","description":"The information for a given load balancer service could be used for\ndebugging and troubleshooting. It includes load balancer service,\nassociated virtual servers, associated pools, associated profiles such as\npersistence, SSL, application, associated monitors and associated rules.\n","properties":{"pools":{"items":{"$ref":"#/definitions/LbPool"},"readOnly":true,"type":"array","description":"The pools which are associated to the given load balancer service would\nbe included. The pools could be defined in virtual server default pool,\nsorry pool or load balancer rule action.\n","title":"Associated load balancer pool settings"},"persistence_profiles":{"items":{"$ref":"#/definitions/LbPersistenceProfile"},"readOnly":true,"type":"array","description":"The persistence profiles are associated to virtual servers\n","title":"Associated load balancer persistence profile settings"},"virtual_servers":{"items":{"$ref":"#/definitions/LbVirtualServer"},"readOnly":true,"type":"array","description":"The virtual servers which are associated to the given load balancer\nservice would be included.\n","title":"Associated virtual server settings"},"client_ssl_profiles":{"description":"The client SSL profiles are associated to virtual servers.\nThe property is deprecated as NSX-T Load Balancer is deprecated.\n","title":"Associated load balancer client SSL profile settings","items":{"$ref":"#/definitions/LbClientSslProfile"},"x-deprecated":true,"readOnly":true,"type":"array"},"server_ssl_profiles":{"description":"The server SSL profiles are associated to virtual servers.\nThe property is deprecated as NSX-T Load Balancer is deprecated.\n","title":"Associated load balancer server SSL profile settings","items":{"$ref":"#/definitions/LbServerSslProfile"},"x-deprecated":true,"readOnly":true,"type":"array"},"service":{"$ref":"#/definitions/LbService"},"rules":{"description":"The load balancer rules are associated to virtual servers.\nThe property is deprecated as NSX-T Load Balancer is deprecated.\n","title":"Associated load balancer rule settings","items":{"$ref":"#/definitions/LbRule"},"x-deprecated":true,"readOnly":true,"type":"array"},"application_profiles":{"items":{"$ref":"#/definitions/LbAppProfile"},"readOnly":true,"type":"array","description":"The application profiles are associated to virtual servers\n","title":"Associated load balancer application profile settings"},"monitors":{"description":"The load balancer monitors are associated to pools.\nThe property is deprecated as NSX-T Load Balancer is deprecated.\n","title":"Associated load balancer monitor configurations","items":{"$ref":"#/definitions/LbMonitor"},"x-deprecated":true,"readOnly":true,"type":"array"}},"title":"The debug information of the load balancer service"},"UpdatePrincipalIdentityCertificateRequest":{"x-vmw-nsx-module":"CertificateManager","allOf":[{"$ref":"#/definitions/ManagedResource"},{"required":["principal_identity_id","certificate_id"],"x-vmw-nsx-module":"CertificateManager","type":"object","properties":{"principal_identity_id":{"readOnly":false,"maxLength":255,"type":"string","description":"Unique ID of the principal.","title":"Principal Identity ID"},"certificate_id":{"readOnly":false,"type":"string","description":"Id of the stored certificate.","title":"Id of the stored certificate"}}}],"description":"Request to update the certificate of a principal identity with a new\ncertificate.\n","title":"Request to update the certificate of a principal identity"},"FieldsFilterData":{"x-vmw-nsx-module":"LiveTrace","allOf":[{"$ref":"#/definitions/LiveTraceFilterData"},{"x-vmw-nsx-module":"LiveTrace","type":"object","properties":{"ip_info":{"$ref":"#/definitions/IpInfo"},"transport_info":{"$ref":"#/definitions/TransportInfo"}}}]},"RemoteTunnelEndpointConfigState":{"x-vmw-nsx-module":"TransportNode","type":"object","description":"Remote tunnel endpoint configuration state","properties":{"endpoints":{"items":{"$ref":"#/definitions/RemoteTunnelEndpoint"},"readOnly":true,"type":"array","description":"List of remote tunnel endpoints which are configured on this node","title":"List of remote tunnel endpoints which are configured on this node"}},"title":"Remote tunnel endpoint configuration state"},"FirewallRuleListResult":{"x-vmw-nsx-module":"Firewall","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"Firewall","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/FirewallRule"},"readOnly":true,"type":"array","description":"Firewall rule list result with pagination support.","title":"Firewall rule list result"}}}]},"MigrationPlanSettings":{"x-vmw-nsx-module":"Migration","type":"object","properties":{"pause_after_each_group":{"default":false,"readOnly":false,"type":"boolean","description":"Flag to indicate whether to pause the migration after migration of each group is completed","title":"Flag to indicate whether to pause the migration after migration of each group is completed"},"pause_on_error":{"default":false,"readOnly":false,"type":"boolean","description":"Flag to indicate whether to pause the migration plan execution when an error occurs","title":"Flag to indicate whether to pause the migration plan execution when an error occurs"},"parallel":{"default":true,"readOnly":false,"type":"boolean","description":"Migration Method to specify whether the migration is to be performed serially or in parallel","title":"Migration Method to specify whether the migration is to be performed serially or in parallel"}}},"Snmpv2cProperties":{"x-vmw-nsx-module":"CentralConfig","type":"object","description":"This object contains list of SNMP v2c communities used to poll NSX nodes over SNMP and list of SNMP v2c targets used to receive SNMP traps/notifications from NSX nodes.","properties":{"communities":{"items":{"$ref":"#/definitions/Snmpv2cCommunity"},"type":"array","description":"List of SNMP v2c communities allowed to poll NSX nodes over SNMP v2c.","maxItems":10,"title":"SNMP v2c communities"},"targets":{"items":{"$ref":"#/definitions/Snmpv2cTarget"},"type":"array","description":"List of SNMP v2c targets/receivers where SNMP v2c traps/notifications will be sent from NSX nodes.","maxItems":3,"title":"SNMP v2c targets"}},"title":"SNMP v2c properties"},"NatStatisticsPerRule":{"x-vmw-nsx-module":"AggSvcLogicalRouter","allOf":[{"$ref":"#/definitions/NatCounters"},{"x-vmw-nsx-module":"AggSvcLogicalRouter","type":"object","properties":{"last_update_timestamp":{"description":"Timestamp when the data was last updated; unset if data source has never updated the data.","format":"int64","readOnly":true,"type":"integer"},"logical_router_id":{"readOnly":true,"type":"string","description":"The id of the logical router which owns the NAT rule.","title":"The id of the logical router which owns the NAT rule."},"id":{"readOnly":true,"type":"string","description":"The id of the NAT rule.","title":"The id of the NAT rule."},"warning_message":{"readOnly":true,"type":"string","description":"The warning message about the NAT Rule statistics.","title":"The warning message about the NAT Rule statistics."}}}]},"FailedNodeSupportBundleResult":{"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"node_display_name":{"readOnly":true,"type":"string","description":"Display name of node","title":"Display name of node"},"node_id":{"readOnly":true,"type":"string","description":"UUID of node","title":"UUID of node"},"error_code":{"readOnly":true,"type":"string","description":"Error code","title":"Error code"},"error_message":{"readOnly":true,"type":"string","description":"Error message","title":"Error message"}}},"LiveTraceStatus":{"x-vmw-nsx-module":"LiveTrace","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"LiveTrace","type":"object","properties":{"filter":{"$ref":"#/definitions/LiveTraceFilterData"},"operation_state":{"readOnly":true,"enum":["IN_PROGRESS","FINISHED","PARTIAL_FINISHED","CANCELED","INVALIDATED","TIMEOUT"],"type":"string","description":"The operation state of Livetrace.\nIN_PROGRESS - collecting the session results.\nFINISHED - session results collection completes.\nPARTIAL_FINISHED - session results may be incomplete.\nCANCELED - session is cancelled by exception.\nINVALIDATED - session is invalidated by configuration changes such as VM migration.\nTIMEOUT - session is not completed on time.\n","title":"Operation state"},"filter_invalid_info":{"items":{"$ref":"#/definitions/LiveTraceFilterInvalidInfo"},"readOnly":true,"type":"array","description":"The detail of invalid filter(s) in a Livetrace session.\nThis field is only applicable for filters of PlainFilterData type.\n","title":"Detail on invalid filter(s) in a Livetrace session."},"timeout":{"description":"Timeout in seconds for livetrace session","title":"Timeout in seconds for livetrace session","format":"int64","maximum":300,"readOnly":true,"minimum":5,"type":"integer"},"source_lport":{"readOnly":true,"type":"string","description":"The source logical port","title":"The source logical port"},"invalidation_reason":{"readOnly":true,"enum":["PORT_DISCONNECT","DP_DESTROY","UNKNOWN"],"type":"string","description":"The reason of invalidating a Livetrace session.\nPORT_DISCONNECT - Source or destination logical port of the session is disconnected.\nDP_DESTROY - Dataplane is destroyed.\nUNKNOWN - The invalidation reason cannot be determined.\n","title":"Livetrace invalidation reason"},"request_status":{"readOnly":true,"enum":["SUCCESS_DELIVERED","LCP_FAILURE","INVALID_FILTER","DATAPATH_FAILURE","CONNECTION_ERROR","TIMEOUT","UNKNOWN"],"type":"string","description":"The status of a Livetrace request.\nSUCCESS_DELIVERED - The request is delivered successfully.\nLCP_FAILURE - LCP agent fails to realize the request.\nINVALID_FILTER - Filter is invalid.\nDATAPATH_FAILURE - Dataplane fails to realize the request.\nTIMEOUT - The response to the request is not received within timeout.\nCONNECTION_ERROR - There is connection error between host components.\nUNKNOWN - The status of request cannot be determined.\n","title":"Livetrace request status"},"actions":{"$ref":"#/definitions/LiveTraceActionConfig"}}}]},"ClusterNodeVMDeploymentConfig":{"description":"Contains info used to configure the VM on deployment","title":"Configuration for deploying cluster node VM","required":["placement_type"],"discriminator":"placement_type","x-vmw-nsx-module":"ClusterNodeVMDeployment","type":"object","properties":{"placement_type":{"enum":["VsphereClusterNodeVMDeploymentConfig"],"type":"string","description":"Specifies the config for the platform through which to deploy the VM\n","title":"Type of deployment"}}},"NtpServiceProperties":{"description":"NTP Service properties","title":"NTP Service properties","required":["servers"],"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"start_on_boot":{"default":true,"type":"boolean","description":"Start NTP service when system boots","title":"Start NTP service when system boots"},"servers":{"items":{"description":"Hostname or IPv4 address","format":"hostname-or-ipv4","type":"string"},"type":"array","description":"NTP servers","title":"NTP servers"}}},"ClusterNodeStatus":{"x-vmw-nsx-module":"ClusterManagement","type":"object","properties":{"system_status":{"$ref":"#/definitions/NodeStatusProperties"},"mgmt_cluster_status":{"$ref":"#/definitions/ManagementClusterNodeStatus"},"version":{"readOnly":true,"type":"string","description":"Software version running on node","title":"Software version running on node"},"control_cluster_status":{"$ref":"#/definitions/ControlClusterNodeStatus"}}},"SyslogProperties":{"description":"This object contains list of syslog exporters used by NSX nodes.","title":"Syslog service properties","required":["exporters"],"x-vmw-nsx-module":"CentralConfig","type":"object","properties":{"exporters":{"items":{"$ref":"#/definitions/SyslogExporter"},"type":"array","description":"List of syslog exporters.","title":"Syslog exporters"}}},"NdpHeader":{"x-vmw-nsx-module":"Traceflow","type":"object","description":"Neighbor discovery protocol header","properties":{"dst_ip":{"description":"The IP address of the destination of the solicitation. It MUST NOT be a multicast address.","format":"ipv6","type":"string"},"msg_type":{"default":"NEIGHBOR_SOLICITATION","enum":["NEIGHBOR_SOLICITATION","NEIGHBOR_ADVERTISEMENT"],"type":"string","description":"This field specifies the type of the Neighbor discover message being sent. NEIGHBOR_SOLICITATION - Neighbor Solicitation message to discover the link-layer address of an on-link IPv6 node or to confirm a previously determined link-layer address. NEIGHBOR_ADVERTISEMENT - Neighbor Advertisement message in response to a Neighbor Solicitation message.","title":"NDP message type"}},"title":"Neighbor discovery protocol header"},"ContainerInfrastructureInfo":{"description":"Details of infrastructure hosting the container cluster\ne.g. vSphere, AWS, VMC etc..\n","title":"Details of container infrastructure","required":["infra_type"],"x-vmw-nsx-module":"InventoryContainerObj","type":"object","properties":{"infra_type":{"readOnly":false,"enum":["vSphere","AWS","Azure","Google","VMC","KVM","Baremetal"],"type":"string","description":"Type of the infrastructure.","title":"Type of the infrastructure"}}},"AdvanceClusterRestoreRequest":{"x-vmw-nsx-module":"ClusterRestore","required":["data"],"type":"object","properties":{"data":{"items":{"$ref":"#/definitions/AdvanceClusterRestoreInput"},"type":"array","description":"List of instructions and their associated data","title":"List of instructions and their associated data"}}},"LogicalPortAttachment":{"description":"Logical port attachment","title":"Logical port attachment","required":["id"],"x-vmw-nsx-module":"LogicalPort","type":"object","properties":{"attachment_type":{"description":"Indicates the type of logical port attachment. By default it is Virtual Machine interface (VIF)","default":"VIF","enum":["VIF","LOGICALROUTER","BRIDGEENDPOINT","DHCP_SERVICE","METADATA_PROXY","L2VPN_SESSION","L2FORWARDER"],"type":"string"},"context":{"$ref":"#/definitions/AttachmentContext"},"id":{"type":"string","description":"Identifier of the interface attached to the logical port","title":"Identifier of the interface attached to the logical port"}}},"UdpHeader":{"x-vmw-nsx-module":"Traceflow","type":"object","properties":{"src_port":{"description":"Source port of udp header","title":"Source port of udp header","default":0,"format":"int64","maximum":65535,"minimum":0,"type":"integer"},"dst_port":{"description":"Destination port of udp header","title":"Destination port of udp header","default":0,"format":"int64","maximum":65535,"minimum":0,"type":"integer"}}},"BgpNeighborRouteDetails":{"x-vmw-nsx-module":"AggSvcLogicalRouter","type":"object","description":"BGP neighbor learned/advertised route details.","properties":{"logical_router_id":{"readOnly":true,"type":"string","description":"Logical router id","title":"Logical router id"},"neighbor_id":{"readOnly":true,"type":"string","description":"BGP neighbor id","title":"BGP neighbor id"},"per_transport_node_routes":{"items":{"$ref":"#/definitions/RoutesPerTransportNode"},"readOnly":true,"type":"array","description":"Array of BGP neighbor route details per transport node.\n","title":"Route details per transport node"},"neighbor_address":{"description":"BGP neighbor peer IP address.","format":"ip","readOnly":true,"type":"string"}},"title":"BGP neighbor route details"},"BFDDiagnosticCount":{"x-vmw-nsx-module":"Heatmap","type":"object","properties":{"concatenated_path_down_count":{"format":"int64","type":"integer","description":"Number of tunnels with concatenated path down diagnostic message","title":"Number of tunnels with concatenated message"},"administratively_down_count":{"format":"int64","type":"integer","description":"Number of tunnels with administratively down diagnostic message","title":"Number of tunnels with administratively message"},"no_diagnostic_count":{"format":"int64","type":"integer","description":"Number of tunnels with no diagnostic","title":"Number of tunnels with no diagnostic"},"path_down_count":{"format":"int64","type":"integer","description":"Number of tunnels with path down diagnostic message","title":"Number of tunnels with path down message"},"reverse_concatenated_path_down_count":{"format":"int64","type":"integer","description":"Number of tunnels with reverse concatenated path down diagnostic message","title":"Number of tunnels with reverse message"},"neighbor_signaled_session_down_count":{"format":"int64","type":"integer","description":"Number of tunnels neighbor signaled session down","title":"Number of tunnels neighbor signaled session down"},"control_detection_time_expired_count":{"format":"int64","type":"integer","description":"Number of tunnels with control detection time expired diagnostic message","title":"Number of tunnels with expired message"},"echo_function_failed_count":{"format":"int64","type":"integer","description":"Number of tunnels with echo function failed diagnostic message","title":"Number of tunnels with failed message"},"forwarding_plane_reset_count":{"format":"int64","type":"integer","description":"Number of tunnels with forwarding plane reset diagnostic message","title":"Number of tunnels with reset message"}}},"L2VPNSessionStatus":{"x-vmw-nsx-module":"L2VPNStatistics","type":"object","description":"L2VPN session status.","properties":{"status":{"readOnly":true,"enum":["UP","DOWN"],"type":"string","description":"L2 VPN session status, specifies UP/DOWN.","title":"L2 VPN session status"},"transport_tunnels":{"items":{"$ref":"#/definitions/L2VPNTransportTunnelStatus"},"readOnly":true,"type":"array","description":"Transport tunnels status.","title":"Transport tunnels status"},"display_name":{"readOnly":true,"type":"string","description":"L2VPN display name.","title":"Display name"},"session_id":{"readOnly":true,"type":"string","description":"L2VPN session identifier.","title":"Session identifier"}},"title":"L2VPN Session Status"},"V2tSiteMapping":{"description":"Details about mapping of NSX-V and NSX-T Local Manager.","title":"Details about mapping of NSX-V and NSX-T Local Manager","required":["federation_site_id"],"x-vmw-nsx-module":"Migration","type":"object","properties":{"nsxv_ip":{"readOnly":true,"format":"hostname-or-ip","type":"string","description":"NSX-V API endpoint IP address","title":"NSX-V API endpoint IP address"},"federation_site_id":{"readOnly":false,"type":"string","description":"Federation NSX-T site id.","title":"Federation NSX-T site id"}}},"EdgeConfigurationState":{"x-vmw-nsx-module":"LogicalRouter","allOf":[{"$ref":"#/definitions/ConfigurationState"},{"x-vmw-nsx-module":"LogicalRouter","type":"object","properties":{"pending_change_list":{"items":{"type":"string"},"readOnly":true,"type":"array","description":"Request identifier of the API which modified the entity.","title":"List of pending changes"}}}],"description":"This contains fields that captures state of Trackable entities.\nEdge and VPN state entities extend this object.\n","title":"Configuration State for Edge and VPN entities."},"AdvertiseRule":{"x-vmw-nsx-module":"Routing","required":["networks"],"type":"object","properties":{"action":{"default":"ALLOW","enum":["DENY","ALLOW"],"type":"string","description":"ALLOW action enables the advertisment and DENY action disables the advertisement of a filtered routes to the connected TIER0 router.","title":"Action to ALLOW or DENY advertisement of routes"},"rule_filter":{"$ref":"#/definitions/AdvertisementRuleFilter"},"display_name":{"maxLength":255,"type":"string","description":"Display name","title":"Display name"},"networks":{"items":{"description":"IPv4 or IPv6 CIDR Block","format":"ip-cidr-block","type":"string"},"type":"array","description":"network(CIDR) to be routed","title":"network(CIDR) to be routed"},"description":{"maxLength":1024,"type":"string","description":"Description","title":"Description"}}},"EdgeClusterState":{"x-vmw-nsx-module":"EdgeClusters","allOf":[{"$ref":"#/definitions/EdgeConfigurationState"},{"x-vmw-nsx-module":"EdgeClusters","type":"object"}],"description":"This holds the state of Edge Cluster. If there are errors in\nrealizing EC outside of MP, it gives details of the components and\nspecific errors.\n","title":"Realization State of Edge Cluster."},"LbRule":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/ManagedResource"},{"required":["phase","actions","match_strategy"],"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"phase":{"enum":["HTTP_REQUEST_REWRITE","HTTP_FORWARDING","HTTP_RESPONSE_REWRITE","HTTP_ACCESS","TRANSPORT"],"type":"string","description":"Each load balancer rule is used at a specific phase of load balancer\nprocessing. Currently five phases are supported, HTTP_REQUEST_REWRITE,\nHTTP_FORWARDING, HTTP_RESPONSE_REWRITE, HTTP_ACCESS and TRANSPORT.\nWhen an HTTP request message is received by load balancer, all\nHTTP_REQUEST_REWRITE rules, if present are executed in the order they\nare applied to virtual server. And then if HTTP_FORWARDING rules\npresent, only first matching rule's action is executed, remaining rules\nare not checked. HTTP_FORWARDING rules can have only one action. If the\nrequest is forwarded to a backend server and the response goes back to\nload balancer, all HTTP_RESPONSE_REWRITE rules, if present, are executed\nin the order they are applied to the virtual server.\nIn HTTP_ACCESS phase, user can define action to control access using\nJWT authentication.\nIn TRANSPORT phase, user can define the condition to match SNI in TLS\nclient hello and define the action to do SSL end-to-end, SSL offloading\nor SSL passthrough using a specific load balancer server pool.\n","title":"Load balancer processing phase"},"match_conditions":{"items":{"$ref":"#/definitions/LbRuleCondition"},"type":"array","description":"A list of match conditions used to match application traffic. Multiple\nmatch conditions can be specified in one load balancer rule, each match\ncondition defines a criterion to match application traffic.\nIf no match conditions are specified, then the load balancer rule will\nalways match and it is used typically to define default rules. If more\nthan one match condition is specified, then match strategy determines\nif all conditions should match or any one condition should match for the\nload balancer rule to considered a match.\n","maxItems":60,"title":"Conditions to match application traffic"},"actions":{"items":{"$ref":"#/definitions/LbRuleAction"},"type":"array","description":"A list of actions to be executed at specified phase when load balancer\nrule matches. The actions are used to manipulate application traffic,\nsuch as rewrite URI of HTTP messages, redirect HTTP messages, etc.\n","maxItems":60,"title":"Actions to be executed"},"match_strategy":{"enum":["ALL","ANY"],"type":"string","description":"Strategy to define how load balancer rule is considered a match when\nmultiple match conditions are specified in one rule. If match_stragety\nis set to ALL, then load balancer rule is considered a match only if all\nthe conditions match. If match_strategy is set to ANY, then load\nbalancer rule is considered a match if any one of the conditions match.\n","title":"Strategy to match multiple conditions"}}}],"description":"Load balancer rules allow customization of load balancing behavior using\nmatch/action rules. Currently, load balancer rules are supported for only\nlayer 7 virtual servers with application profile LbHttpProfile.\nEach application rule consists of one or more match conditions and one or\nmore actions.\nLoad balancer rules could be used by different load balancer services.\n","title":"Load balancer rules"},"ICMPTypeNSService":{"x-vmw-nsx-module":"Types","allOf":[{"$ref":"#/definitions/NSServiceElement"},{"required":["protocol"],"x-vmw-nsx-module":"Types","type":"object","properties":{"icmp_code":{"format":"int64","type":"integer","description":"ICMP message code","title":"ICMP message code"},"icmp_type":{"format":"int64","type":"integer","description":"ICMP message type","title":"ICMP message type"},"protocol":{"enum":["ICMPv4","ICMPv6"],"type":"string","description":"ICMP protocol type","title":"ICMP protocol type"}}}],"description":"A NSService that represents IPv4 or IPv6 ICMP protocol","title":"A NSService that represents IPv4 or IPv6 ICMP protocol"},"CapacityDashboardUsage":{"x-vmw-nsx-module":"CapacityDashboard","required":["current_usage_count","max_threshold_percentage","display_name","severity","min_threshold_percentage","current_usage_percentage","max_supported_count","usage_type"],"type":"object","properties":{"current_usage_count":{"format":"int64","type":"integer","description":"Indicate the current usage count of object type.\n","title":"Current usage count of object type"},"max_threshold_percentage":{"type":"number","description":"This indicates the maximum threshold percentage for object type.\n","title":"Max threshold percentage for object type"},"display_name":{"type":"string","description":"Display name for NSX object type.\n","title":"User friendly name for object type"},"severity":{"enum":["INFO","WARNING","CRITICAL","ERROR"],"type":"string","description":"Severity calculated from percentage usage\n","title":"Severity calculated from percentage usage"},"max_supported_count":{"format":"int64","type":"integer","description":"This is the maximum supported count for object type in consideration.\n","title":"Maximum supported count for object type"},"usage_type":{"type":"string","description":"Indicate the object type for which usage is calculated.\n","title":"Object type for which usage is fetched"},"min_threshold_percentage":{"type":"number","description":"This indicates the minimum threshold percentage for object type.\n","title":"Min threshold percentage for object type"},"current_usage_percentage":{"type":"number","description":"Current usage percentage for object type\n","title":"Current usage percentage"}}},"LbHttpMonitor":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/LbActiveMonitor"},{"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"response_status_codes":{"items":{"type":"integer","format":"int32"},"type":"array","description":"The HTTP response status code should be a valid HTTP status code.\n","maxItems":64,"title":"Array of single HTTP response status codes"},"request_method":{"description":"the health check method for HTTP monitor type","default":"GET","enum":["GET","OPTIONS","POST","HEAD","PUT"],"type":"string"},"request_body":{"type":"string","description":"String to send as part of HTTP health check request body. Valid only\nfor certain HTTP methods like POST.\n","title":"String to send as part of HTTP health check request body. Valid only\nfor certain HTTP methods like POST.\n"},"response_body":{"type":"string","description":"If HTTP response body match string (regular expressions not supported)\nis specified (using LbHttpMonitor.response_body) then the\nhealthcheck HTTP response body is matched against the specified string\nand server is considered healthy only if there is a match.\nIf the response body string is not specified, HTTP healthcheck is\nconsidered successful if the HTTP response status code is 2xx, but it\ncan be configured to accept other status codes as successful.\n","title":"response body to match"},"request_url":{"type":"string","description":"URL used for HTTP monitor","title":"URL used for HTTP monitor"},"request_version":{"description":"HTTP request version","default":"HTTP_VERSION_1_1","enum":["HTTP_VERSION_1_0","HTTP_VERSION_1_1"],"type":"string"},"request_headers":{"items":{"$ref":"#/definitions/LbHttpRequestHeader"},"type":"array","description":"Array of HTTP request headers","title":"Array of HTTP request headers"}}}]},"TransportZoneProfileTypeIdEntry":{"x-vmw-nsx-module":"TransportZoneProfile","required":["profile_id"],"type":"object","properties":{"profile_id":{"readOnly":false,"type":"string","description":"profile id of the resource type"},"resource_type":{"description":"Selects the type of the transport zone profile","enum":["BfdHealthMonitoringProfile"],"type":"string"}}},"StaticIpListSpec":{"x-vmw-nsx-module":"TransportNode","allOf":[{"$ref":"#/definitions/IpAssignmentSpec"},{"required":["subnet_mask","ip_list","default_gateway"],"x-vmw-nsx-module":"TransportNode","type":"object","properties":{"subnet_mask":{"description":"Subnet mask","format":"ip","readOnly":false,"type":"string"},"ip_list":{"description":"List of IPs for transport node host switch virtual tunnel endpoints","title":"List of IPs for transport node host switch virtual tunnel endpoints","items":{"description":"IPv4 or IPv6 address","format":"ip","type":"string"},"readOnly":false,"maxItems":32,"type":"array"},"default_gateway":{"description":"Gateway IP","format":"ip","readOnly":false,"type":"string"}}}],"description":"IP assignment specification for Static IP List.","title":"IP assignment specification for Static IP List."},"LbHttpRequestUriRewriteAction":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/LbRuleAction"},{"required":["uri"],"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"uri_arguments":{"type":"string","description":"Query string of URI, typically contains key value pairs, for example:\nfoo1=bar1&foo2=bar2\n","title":"URI arguments"},"uri":{"type":"string","description":"URI of HTTP request","title":"URI of HTTP request"}}}],"description":"This action is used to rewrite URIs in matched HTTP request messages.\nSpecify the uri and uri_arguments fields in this condition to rewrite the\nmatched HTTP request message's URI and URI arguments to the new values.\nFull URI scheme of HTTP messages have following syntax:\nscheme:[//[user[:password]@]host[:port]][/path][?query][#fragment]\nThe uri field of this action is used to rewrite the /path part in above\nscheme. And the uri_arguments field is used to rewrite the query part.\nCaptured variables and built-in variables can be used in the uri and\nuri_arguments fields.\nCheck the example in LbRuleAction to see how to use variables in this\naction.\n","title":"Action to rewrite HTTP request URIs."},"InstructionInfo":{"x-vmw-nsx-module":"ClusterRestore","type":"object","description":"Details of the instructions displayed during restore process","properties":{"fields":{"items":{"type":"string"},"readOnly":true,"type":"array","description":"A list of fields that are displayable to users in a table","title":"Displayable fields"},"id":{"readOnly":true,"type":"string","description":"UUID of the instruction","title":"UUID of the instruction"},"actions":{"items":{"type":"string"},"readOnly":true,"type":"array","description":"A list of actions that are to be applied to resources","title":"Actions list"},"name":{"readOnly":true,"type":"string","description":"Instruction name","title":"Instruction name"}},"title":"Details of the instructions displayed during restore process"},"LogicalSwitchStatus":{"x-vmw-nsx-module":"LogicalSwitch","type":"object","properties":{"num_logical_ports":{"readOnly":true,"format":"int32","type":"integer","description":"Count of Logical Ports belonging to this switch","title":"Count of Logical Ports belonging to this switch"},"logical_switch_id":{"readOnly":true,"type":"string","description":"Unique ID identifying the the Logical Switch","title":"Unique ID identifying the the Logical Switch"}}},"HeatMapTransportZoneStatus":{"x-vmw-nsx-module":"Heatmap","type":"object","properties":{"degraded_count":{"format":"int32","type":"integer","description":"Number of transport nodes that are degraded","title":"Number of transport nodes that are degraded"},"down_count":{"format":"int32","type":"integer","description":"Number of transport nodes that are down","title":"Number of transport nodes that are down"},"unknown_count":{"format":"int32","type":"integer","description":"Number of transport nodes with unknown status","title":"Number of transport nodes with unknown status"},"up_count":{"format":"int32","type":"integer","description":"Number of transport nodes that are up","title":"Number of transport nodes that are up"}}},"CertificateCheckingStatus":{"x-vmw-nsx-module":"CertificateManager","type":"object","description":"Result of checking a certificate","properties":{"status":{"description":"Status of the checked certificate.","enum":["OK","CRL_NOT_READY","REJECTED","ERROR"],"readOnly":true,"type":"string"},"error_message":{"readOnly":true,"type":"string","description":"Error message when checking the certificate.","title":"Error Message"}},"title":"Result of checking a certificate"},"LbTcpHeaderCondition":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/LbRuleCondition"},{"required":["source_port"],"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"source_port":{"description":"TCP source port of HTTP message","format":"port-or-range","type":"string"}}}],"description":"This condition is used to match TCP header fields of HTTP messages.\nCurrently, only the TCP source port is supported. Ports can be expressed as\na single port number like 80, or a port range like 1024-1030.\n","title":"Condition to match TCP header fields"},"AttachedInterface":{"description":"The Attached interface is only effective for the port on Bare metal server.\n","title":"Attached interface specification for Bare metal server","required":["app_intf_name"],"x-vmw-nsx-module":"LogicalPort","type":"object","properties":{"routing_table":{"items":{"type":"string"},"type":"array","description":"Routing rules","title":"Routing rules"},"migrate_intf":{"type":"string","description":"IP configuration on migrate_intf will migrate to app_intf_name. It is used for Management and Application sharing the same IP.","title":"Interface name to migrate"},"app_intf_name":{"type":"string","description":"The name of application interface","title":"The name of application interface"},"default_gateway":{"description":"Gateway IP","format":"ip","type":"string"}}},"BackupOperationStatus":{"description":"Backup operation status","title":"Backup operation status","required":["backup_id","success"],"x-vmw-nsx-module":"BackupConfiguration","type":"object","properties":{"backup_id":{"type":"string","description":"Unique identifier of a backup","title":"Unique identifier of a backup"},"end_time":{"type":"integer","description":"Time when operation was ended","format":"int64"},"success":{"type":"boolean","description":"True if backup is successfully completed, else false","title":"True if backup is successfully completed, else false"},"start_time":{"type":"integer","description":"Time when operation was started","format":"int64"},"error_message":{"type":"string","description":"Error code details","title":"Error code details"},"error_code":{"enum":["BACKUP_NOT_RUN_ON_MASTER","BACKUP_SERVER_UNREACHABLE","BACKUP_AUTHENTICATION_FAILURE","BACKUP_PERMISSION_ERROR","BACKUP_TIMEOUT","BACKUP_BAD_FINGERPRINT","BACKUP_GENERIC_ERROR","UPGRADE_IN_PROGRESS"],"type":"string","description":"Error code","title":"Error code"}}},"LbSourceIpPersistenceProfile":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/LbPersistenceProfile"},{"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"purge":{"description":"persistence purge setting","default":"FULL","enum":["NO_PURGE","FULL"],"type":"string"},"ha_persistence_mirroring_enabled":{"default":false,"type":"boolean","description":"Persistence entries are not synchronized to the HA peer by default.\nThe property is deprecated as NSX-T Load Balancer is deprecated.\n","x-deprecated":true,"title":"mirroring enabled flag to synchronize persistence entries"},"timeout":{"description":"When all connections complete (reference count reaches 0), persistence\nentry timer is started with the expiration time.\n","title":"persistence entry expiration time in seconds","default":300,"format":"int64","maximum":2147483647,"minimum":1,"type":"integer"}}}]},"IdfwUserSessionData":{"description":"Identity Firewall user session data on a client machine (typically a VM).\nMultiple entries for the same user can be returned if the user logins to\nmultiple sessions on the same VM.\n","title":"Identity Firewall user session data on client machine","required":["login_time","user_name","domain_name","user_session_id"],"x-vmw-nsx-module":"IdentityFirewall","type":"object","properties":{"session_source":{"readOnly":true,"enum":["GI","ELS","LI"],"type":"string","description":"User session source can be one of:\n - GI (Guest Introspection)\n - ELS (AD Event log server)\n - LI (Log Insight)\n","title":"Source for the user session"},"user_id":{"readOnly":true,"type":"string","description":"AD user ID (may not exist).","title":"AD user ID (may not exist)"},"user_session_id":{"format":"int32","type":"integer","description":"User session ID. This also indicates whether this is VDI / RDSH.","title":"User session ID"},"vm_ext_id":{"readOnly":true,"type":"string","description":"Virtual machine (external ID or BIOS UUID) where login/logout events occurred.","title":"Virtual machine external ID or BIOS UUID"},"id":{"readOnly":true,"type":"string","description":"Identifier of user session data.","title":"User session data Identifier"},"login_time":{"type":"integer","description":"Login time.","format":"int64"},"user_name":{"type":"string","description":"AD user name.","title":"AD user name"},"logout_time":{"type":"integer","description":"Logout time if applicable. An active user session has no logout time.\nNon-active user session is stored (up to last 5 most recent entries) per\nVM and per user.\n","format":"int64"},"domain_name":{"type":"string","description":"AD Domain of user.","title":"AD Domain"}}},"IPSet":{"x-vmw-nsx-module":"IPSet","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"IPSet","type":"object","properties":{"ip_addresses":{"items":{"description":"IPElement can be a single IP address, IP address range or a Subnet. Its\ntype can be of IPv4 or IPv6. Supported list of formats are \"192.168.1.1\",\n\"192.168.1.1-192.168.1.100\", \"192.168.0.0/24\",\n\"fe80::250:56ff:fe83:318c\",\n\"fe80::250:56ff:fe83:3181-fe80::250:56ff:fe83:318c\",\n\"fe80::250:56ff:fe83:318c/64\"\n","format":"address-or-block-or-range","type":"string"},"type":"array","description":"IP addresses","maxItems":4000,"title":"IP addresses"}}}],"description":"IPSet is used to group individual IP addresses, range of IP addresses or subnets.\nAn IPSet is a homogeneous group of IP addresses, either of type IPv4 or of type\nIPv6. IPSets can be used as source or destination in firewall rules. These can\nalso be used as members of NSGroups.\n","title":"Set of one or more IP addresses"},"FirewallSectionRuleList":{"x-vmw-nsx-module":"Firewall","allOf":[{"$ref":"#/definitions/FirewallSection"},{"x-vmw-nsx-module":"Firewall","required":["rules"],"type":"object","properties":{"rules":{"description":"List of firewall rules in the section. Only homogenous rules are supported.","title":"List of the firewall rules","items":{"$ref":"#/definitions/FirewallRule"},"readOnly":false,"maxItems":1000,"type":"array"}}}]},"IpfixDfwConfig":{"x-vmw-nsx-module":"Ipfix","allOf":[{"$ref":"#/definitions/IpfixConfig"},{"required":["priority","collector","observation_domain_id"],"x-vmw-nsx-module":"Ipfix","type":"object","properties":{"priority":{"description":"This priority field is used to resolve conflicts in Logical Ports\nwhich are covered by more than one IPFIX profiles. The IPFIX\nexporter will send records to Collectors in highest priority\nprofile (lowest number) only.\n","title":"Config Priority","default":0,"format":"int64","maximum":65536,"minimum":0,"type":"integer"},"collector":{"type":"string","description":"Each IPFIX DFW config can have its own collector config.\n","title":"UUID of IPFIX DFW Collector Config"},"active_flow_export_timeout":{"description":"For long standing active flows, IPFIX records will be sent per timeout period\n","title":"Active flow export timeout (minutes)","default":1,"format":"int64","maximum":60,"minimum":1,"type":"integer"},"template_parameters":{"$ref":"#/definitions/IpfixDfwTemplateParameters"},"observation_domain_id":{"description":"An identifier that is unique to the exporting process and used to\nmeter the Flows.\n","format":"int64","title":"Observation domain ID","maximum":4294967295,"minimum":0,"type":"integer"}}}],"description":"It defines IPFIX DFW Configuration.","title":"IPFIX Config for the DFW Module"},"LogicalRouterPortArpTableInCsvFormat":{"x-vmw-nsx-module":"AggSvcLogicalRouterPort","allOf":[{"$ref":"#/definitions/CsvListResult"},{"x-vmw-nsx-module":"AggSvcLogicalRouterPort","type":"object","properties":{"last_update_timestamp":{"description":"Timestamp when the data was last updated; unset if data source has never updated the data.","format":"int64","readOnly":true,"type":"integer"},"results":{"items":{"$ref":"#/definitions/LogicalRouterPortArpCsvRecord"},"type":"array"}}}]},"NodeUserPasswordProperty":{"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"password":{"type":"string","description":"The new password for user","title":"The new password for user"}}},"IpfixConfig":{"x-vmw-nsx-module":"Ipfix","allOf":[{"$ref":"#/definitions/ManagedResource"},{"required":["resource_type"],"discriminator":"resource_type","x-vmw-nsx-module":"Ipfix","type":"object","properties":{"applied_tos":{"description":"List of objects where the IPFIX Config will be enabled.","title":"AppliedTo List","items":{"$ref":"#/definitions/ResourceReference"},"readOnly":false,"maxItems":128,"type":"array"},"resource_type":{"description":"Supported IPFIX Config Types.","enum":["IpfixDfwConfig"],"readOnly":false,"type":"string"}}}],"description":"IPFIX Config base representation","title":"IPFIX Config base representation"},"NiocProfile":{"x-vmw-nsx-module":"NiocProfile","allOf":[{"$ref":"#/definitions/BaseHostSwitchProfile"},{"x-vmw-nsx-module":"NiocProfile","type":"object","properties":{"host_infra_traffic_res":{"items":{"$ref":"#/definitions/ResourceAllocation"},"type":"array","description":"host_infra_traffic_res specifies bandwidth allocation for\nvarious traffic resources.\n","title":"Resource allocation associated with NiocProfile"},"enabled":{"default":true,"type":"boolean","description":"The enabled property specifies the status of NIOC feature.\nWhen enabled is set to true, NIOC feature is turned on and\nthe bandwidth allocations specified for the traffic resources\nare enforced. When enabled is set to false, NIOC feature\nis turned off and no bandwidth allocation is guaranteed.\nBy default, enabled will be set to true.\n","title":"Enabled status of NIOC feature"}}}],"description":"This profile is created for Network I/O Control(NIOC).\n","title":"Profile for Nioc"},"LbHttpRequestUriCondition":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/LbRuleCondition"},{"required":["uri"],"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"match_type":{"description":"Match type of URI","default":"REGEX","enum":["STARTS_WITH","ENDS_WITH","EQUALS","CONTAINS","REGEX"],"type":"string"},"uri":{"type":"string","description":"A string used to identify resource","title":"A string used to identify resource"},"case_sensitive":{"default":true,"type":"boolean","description":"If true, case is significant when comparing URI.\n","title":"A case sensitive flag for URI comparing"}}}],"description":"This condition is used to match URIs(Uniform Resource Identifier) of HTTP\nrequest messages. The URI field can be specified as a regular expression.\nIf an HTTP request message is requesting an URI which matches specified\nregular expression, it matches the condition.\nThe syntax of whole URI looks like this:\nscheme:[//[user[:password]@]host[:port]][/path][?query][#fragment]\nThis condition matches only the path part of entire URI.\nWhen match_type field is specified as REGEX, the uri field is used as a\nregular expression to match URI path of HTTP requests. For example, to\nmatch any URI that has \"/image/\" or \"/images/\", uri field can be specified\nas: \"/image[s]?/\".\nNamed capturing groups can be used in the uri field to capture substrings\nof matched URIs and store them in variables for use in LbRuleAction. For\nexample, specify uri field as:\n\"/news/(?<year>\\d+)/(?<month>\\d+)/(?<article>.*)\"\nIf the URI path is /articles/news/2017/06/xyz.html, then substring \"2017\"\nis captured in variable year, \"06\" is captured in variable month, and\n\"xyz.html\" is captured in variable article. These variables can then\nbe used in an LbRuleAction field which supports variables, such as uri\nfield of LbHttpRequestUriRewriteAction. For example, set the uri field\nof LbHttpRequestUriRewriteAction as:\n\"/articles/news/$year-$month-$article\"\nThen the URI path /articles/news/2017/06/xyz.html is rewritten to:\n\"/articles/news/2017-06-xyz.html\"\n","title":"Condition to match URIs of HTTP request messages"},"StaticIpMacListSpec":{"x-vmw-nsx-module":"TransportNode","allOf":[{"$ref":"#/definitions/IpAssignmentSpec"},{"required":["subnet_mask","ip_mac_list","default_gateway"],"x-vmw-nsx-module":"TransportNode","type":"object","properties":{"subnet_mask":{"description":"Subnet mask","format":"ip","readOnly":false,"type":"string"},"ip_mac_list":{"description":"List of IPs and MACs for transport node host switch virtual tunnel endpoints","title":"List of IPs and MACs for transport node host switch virtual tunnel endpoints","items":{"$ref":"#/definitions/IpMacPair"},"readOnly":false,"maxItems":32,"type":"array"},"default_gateway":{"description":"Gateway IP","format":"ip","readOnly":false,"type":"string"}}}],"description":"IP and MAC assignment specification for Static IP List.","title":"IP and MAC assignment specification for Static IP List."},"SIPacketTypeAndCounter":{"x-vmw-nsx-module":"ServiceInsertionVMDeployment","required":["counter","packet_type"],"type":"object","properties":{"counter":{"format":"int64","type":"integer","description":"The number of packets.","title":"The number of packets."},"packet_type":{"type":"string","description":"The type of the packets","title":"The type of the packets"}}},"VlanMirrorSource":{"x-vmw-nsx-module":"PortMirroring","allOf":[{"$ref":"#/definitions/MirrorSource"},{"x-vmw-nsx-module":"PortMirroring","required":["vlan_ids"],"type":"object","properties":{"vlan_ids":{"minItems":1,"items":{"type":"integer","description":"Virtual Local Area Network Identifier","format":"int64"},"type":"array","description":"Source VLAN ID list","title":"Source VLAN ID list"}}}]},"UpgradeBundleUploadStatus":{"x-vmw-nsx-module":"Upgrade","type":"object","description":"Upload status of upgrade bundle uploaded from url","properties":{"url":{"readOnly":true,"type":"string","description":"URL for uploading upgrade bundle","title":"URL from which the bundle was uploaded"},"status":{"readOnly":true,"enum":["UPLOADING","VERIFYING","SUCCESS","FAILED"],"type":"string","description":"Current status of upgrade bundle upload","title":"Status of upgrade bundle upload"},"detailed_status":{"readOnly":true,"type":"string","description":"Detailed status of upgrade bundle upload","title":"Detailed status of bundle upload"},"percent":{"readOnly":true,"type":"number","description":"Percent of bundle uploaded from URL","title":"Percent of upload completed"}},"title":"Upload status of upgrade bundle"},"L2VpnSessionPeerCodes":{"description":"Get the peer_code for each tunnel to paste on the remote end of the tunnel. Currently only stand-along/unmanaged edge is supported on the remote end of the tunnel.","title":"Peer code to configure the other side of the tunnel","required":["peer_codes"],"x-vmw-nsx-module":"L2VPN","type":"object","properties":{"peer_codes":{"description":"List of peer codes per transport tunnel.","title":"List of peer codes","minItems":1,"items":{"$ref":"#/definitions/L2VpnTunnelPeerCode"},"maxItems":1,"type":"array"}}},"ListResultQueryParameters":{"x-vmw-nsx-module":"Common","type":"object","description":"Parameters that affect how list results are processed","properties":{"fields":{"type":"string","description":"Comma-separated field names to include in query result","title":"Fields to include in query results"}},"title":"Parameters that affect how list results are processed"},"SshKeyPropertiesListResult":{"x-vmw-nsx-module":"MISSING_MODULE","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/SshKeyProperties"},"type":"array","description":"SSH key properties query results","title":"SSH key properties query results"}}}],"description":"SSH key properties query results","title":"SSH key properties query results"},"TelemetryProxy":{"x-vmw-nsx-module":"TelemetryConfig","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"TelemetryConfig","required":["scheme","hostname","port"],"type":"object","properties":{"username":{"type":"string","description":"Specify the user name used to authenticate with the proxy server, if required.\n","title":"User name"},"password":{"type":"string","description":"Specify the password used to authenticate with the proxy server, if required.\nA GET call on /telemetry/config returns a non-meaningful password to maintain\nsecurity. To change the password to a new value, issue a PUT call after updating\nthis field. To remove the password, issue a PUT call after emptying this field.\nTo retain a previously set password, issue a PUT call keeping the non-meaningful\nvalue obtained from the GET call.\n","title":"Password"},"scheme":{"enum":["HTTP","HTTPS"],"type":"string","description":"The scheme accepted by the proxy server. Specify one of HTTP and HTTPS.\n","title":"The scheme accepted by the proxy server"},"hostname":{"format":"hostname-or-ip","type":"string","description":"Specify the fully qualified domain name, or ip address, of the proxy server.\n","title":"FQDN or IP address of the proxy server"},"port":{"format":"int32","type":"integer","description":"Specify the port of the proxy server.","title":"Configured port for proxy"}}}]},"MetadataProxyStatisticsPerLogicalSwitch":{"x-vmw-nsx-module":"AggSvcMetadataProxy","required":["requests_to_nova_server","succeeded_responses_from_nova_server","logical_switch_id","requests_from_clients","responses_to_clients","error_responses_from_nova_server"],"type":"object","properties":{"requests_to_nova_server":{"format":"int64","type":"integer","description":"requests to nova server","title":"requests to nova server"},"responses_to_clients":{"format":"int64","type":"integer","description":"responses to clients","title":"responses to clients"},"succeeded_responses_from_nova_server":{"format":"int64","type":"integer","description":"succeeded responses from nova server","title":"succeeded responses from nova server"},"logical_switch_id":{"type":"string","description":"uuid of attached logical switch","title":"uuid of attached logical switch"},"requests_from_clients":{"format":"int64","type":"integer","description":"requests from clients","title":"requests from clients"},"error_responses_from_nova_server":{"format":"int64","type":"integer","description":"error responses from nova server","title":"error responses from nova server"}}},"ServiceInsertionSection":{"x-vmw-nsx-module":"ServiceInsertionRules","allOf":[{"$ref":"#/definitions/DSSection"},{"x-vmw-nsx-module":"ServiceInsertionRules","type":"object","properties":{"tcp_strict":{"default":false,"type":"boolean","description":"Ensures that a three way TCP handshake is done before the data packets are sent if the value is set to be true. tcp_strict=true is supported only for stateful sections.","title":"TCP Strict"}}}],"description":"A ServiceInsertion section composed of ServiceInsertion Rules.","title":"ServiceInsertion Section"},"LogicalRouterRouteTableInCsvFormat":{"x-vmw-nsx-module":"AggSvcLogicalRouter","allOf":[{"$ref":"#/definitions/CsvListResult"},{"x-vmw-nsx-module":"AggSvcLogicalRouter","type":"object","properties":{"last_update_timestamp":{"description":"Timestamp when the data was last updated; unset if data source has never updated the data.","format":"int64","readOnly":true,"type":"integer"},"results":{"items":{"$ref":"#/definitions/LogicalRouterRouteCsvRecord"},"type":"array"}}}]},"BridgeEndpointProfile":{"x-vmw-nsx-module":"BridgeEndpointProfile","allOf":[{"$ref":"#/definitions/ManagedResource"},{"required":["edge_cluster_id"],"x-vmw-nsx-module":"BridgeEndpointProfile","type":"object","properties":{"failover_mode":{"default":"PREEMPTIVE","enum":["PREEMPTIVE","NON_PREEMPTIVE"],"type":"string","description":"Faileover mode can be preemmptive or non-preemptive","title":"Failover mode for the edge bridge cluster"},"edge_cluster_member_indexes":{"items":{"type":"integer","format":"int32"},"type":"array","description":"First index will be used as the preferred member","title":"Indexes of the member hosts of the edge bridge cluster"},"high_availability_mode":{"default":"ACTIVE_STANDBY","enum":["ACTIVE_STANDBY"],"type":"string","description":"High avaialability mode can be active-active or active-standby","title":"High availability mode for the edge bridge cluster"},"edge_cluster_id":{"maxLength":36,"type":"string","description":"UUID of the edge cluster for this bridge endpoint","title":"UUID of the edge cluster for this bridge endpoint"}}}],"description":"Bridge Endpoint Profile","title":"Bridge Endpoint Profile"},"LbHttpResponseHeaderRewriteAction":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/LbRuleAction"},{"required":["header_value","header_name"],"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"header_value":{"type":"string","description":"Value of header field","title":"Value of header field"},"header_name":{"type":"string","description":"Name of a header field of HTTP request message","title":"Name of a header field of HTTP request message"}}}],"description":"This action is used to rewrite header fields of HTTP response messages to\nspecified new values at HTTP_RESPONSE_REWRITE phase. One action can be used\nto rewrite one header field. To rewrite multiple header fields, multiple\nactions must be defined.\nCaptured variables and built-in variables can be used in the header_value\nfield, header_name field does not support variables.\n","title":"Action to rewrite HTTP response header fields"},"NodeInterSiteStatistics":{"x-vmw-nsx-module":"AggSvcInterSite","type":"object","properties":{"last_update_timestamp":{"description":"Timestamp when the remote tunnel port statistics was last updated.\n","format":"int64","readOnly":true,"type":"integer"},"stats_per_site":{"items":{"$ref":"#/definitions/RemoteTunnelStatisticsPerSite"},"readOnly":true,"type":"array","description":"Remote tunnel statistics per site.","title":"Remote tunnel statistics per site"},"transport_node_id":{"readOnly":true,"type":"string","description":"Edge node id whose statistics is being reported.","title":"Edge node id"}}},"IntelligenceClusterNodeVMDeploymentStatusReport":{"description":"Contains up-to-date information relating to an auto-deployed VM, including\nits status and (potentially) an error message.\n","title":"Report of a VM's deployment status","required":["status"],"x-vmw-nsx-module":"NsxIntelligenceDeployment","type":"object","properties":{"status":{"enum":["NOT_AVAILABLE","VM_DEPLOYMENT_QUEUED","VM_DEPLOYMENT_IN_PROGRESS","VM_DEPLOYMENT_FAILED","VM_POWER_ON_IN_PROGRESS","VM_POWER_ON_FAILED","VM_POWER_ON_SUCCESSFUL","VM_REGISTRATION_IN_PROGRESS","VM_REGISTRATION_SUCCESSFUL","VM_REGISTRATION_FAILED","VM_WAITING_TO_COME_ONLINE","VM_ONLINE_FAILED","VM_POWER_OFF_IN_PROGRESS","VM_POWER_OFF_FAILED","WAITING_TO_UNDEPLOY_VM","VM_UNDEPLOY_IN_PROGRESS","VM_UNDEPLOY_FAILED","VM_UNDEPLOY_SUCCESSFUL","UNKNOWN_STATE"],"type":"string","description":"Status of the addition or deletion of an auto-deployed NSX-Intelligence cluster node VM.\n","title":"Auto-deployed VM's deployment status"},"deployment_progress_state":{"$ref":"#/definitions/ClusterNodeVMDeploymentProgressState"},"failure_message":{"type":"string","description":"In case of auto-deployment-related failure, an error message will be\nstored here.\n","title":"Error message for failure"},"failure_code":{"format":"int64","type":"integer","description":"In case of auto-deployment-related failure, the code for the error will\nbe stored here.\n","title":"Error code for failure"}}},"DiscoveredResourceScope":{"x-vmw-nsx-module":"Common","type":"object","description":"Scope of discovered resource","properties":{"scope_type":{"enum":["CONTAINER_CLUSTER"],"type":"string","description":"Type of the scope for the discovered resource.","title":"Type of scope"},"scope_id":{"type":"string","description":"Specifies the scope id of discovered resource.\n","title":"Scope Id of scope for discovered resource"}},"title":"Scope of discovered resource"},"SecurityGlobalConfig":{"x-vmw-nsx-module":"GlobalConfigs","allOf":[{"$ref":"#/definitions/GlobalConfigs"},{"x-vmw-nsx-module":"GlobalConfigs","type":"object","properties":{"eku_checking_enabled":{"default":true,"type":"boolean","description":"When this flag is set to true, during certificate checking the Extended Key Usage extension is expected to be present, indicating whether the certificate is to be used a client certificate or server certificate. Setting this value to false is not recommended as it leads to lower security and operational risk.","title":"A flag to indicate whether the Extended Key Usage extension in the certificate is checked."},"ca_signed_only":{"default":false,"type":"boolean","description":"When this flag is set to true (for NDcPP compliance) only ca-signed certificates will be allowed to be applied as server certificates.","title":"A flag to indicate whether the server certs are only allowed to be ca-signed."},"crl_checking_enabled":{"default":true,"type":"boolean","description":"When this flag is set to true, during certificate checking the CRL is fetched and checked whether the certificate is revoked or not.","title":"A flag to indicate whether the Java trust-managers check certificate revocation"}}}],"description":"NSX global configs for security purposes, like trust store and trust manager.","title":"NSX global configs for security purposes, like trust store and trust manager."},"CopyToRemoteFileProperties":{"x-vmw-nsx-module":"MISSING_MODULE","allOf":[{"$ref":"#/definitions/CopyRemoteFileProperties"},{"x-vmw-nsx-module":"MISSING_MODULE","required":["protocol"],"type":"object","properties":{"protocol":{"$ref":"#/definitions/Protocol"}}}]},"LbSelectPoolAction":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/LbRuleAction"},{"required":["pool_id"],"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"pool_name":{"readOnly":true,"type":"string","description":"Display name of load balancer pool","title":"Display name of load balancer pool"},"pool_id":{"type":"string","description":"UUID of load balancer pool","title":"UUID of load balancer pool"}}}],"description":"This action is used to select a pool for matched HTTP request messages. The\npool is specified by UUID. The matched HTTP request messages are forwarded\nto the specified pool.\n","title":"Action to select a pool for HTTP request messages"},"NvdsUpgradePrecheckId":{"x-vmw-nsx-module":"NvdsUpgradeReadinessCheck","type":"object","description":"Nvds upgrade precheck ID","properties":{"precheck_id":{"readOnly":true,"type":"string","description":"Tracking ID of nvds upgrade precheck","title":"Tracking ID of nvds upgrade precheck"}},"title":"Nvds upgrade precheck ID"},"NodePolicyServiceProperties":{"x-vmw-nsx-module":"MISSING_MODULE","allOf":[{"$ref":"#/definitions/NodeServiceProperties"},{"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"service_properties":{"$ref":"#/definitions/LoggingServiceProperties"}}}],"description":"Node service properties","title":"Node service properties"},"UpgradeUnitGroup":{"x-vmw-nsx-module":"Upgrade","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"Upgrade","required":["type"],"type":"object","properties":{"enabled":{"default":true,"readOnly":false,"type":"boolean","description":"Flag to indicate whether upgrade of this group is enabled or not","title":"Flag to indicate whether upgrade of this group is enabled or not"},"upgrade_unit_count":{"readOnly":true,"format":"int32","type":"integer","description":"Number of upgrade units in the group","title":"Count of upgrade units in the group"},"type":{"readOnly":false,"type":"string","description":"Component type","title":"Component type"},"upgrade_units":{"description":"List of upgrade units in the group","title":"List of upgrade units in the group","items":{"$ref":"#/definitions/UpgradeUnit"},"readOnly":false,"maxItems":100,"type":"array"},"extended_configuration":{"description":"Extended configuration for the group. Following extended_configuration is supported:\n\nKey: upgrade_mode\nSupported values: maintenance_mode, in_place, stage_in_vlcm\n\nKey: maintenance_mode_config_vsan_mode\nSupported values: evacuate_all_data, ensure_object_accessibility, no_action\n\nKey: maintenance_mode_config_evacuate_powered_off_vms\nSupported values: true, false\n\nKey: rebootless_upgrade\nSupported values: true, false\n","title":"Extended configuration for the group","items":{"$ref":"#/definitions/KeyValuePair"},"readOnly":false,"maxItems":100,"type":"array"},"parallel":{"default":true,"readOnly":false,"type":"boolean","description":"Upgrade method to specify whether the upgrade is to be performed in parallel or serially","title":"Upgrade method to specify whether the upgrade is to be performed in parallel or serially"}}}]},"PolicyTraceflowObservationReceivedLogical":{"x-vmw-nsx-module":"PolicyConnectivity","allOf":[{"$ref":"#/definitions/TraceflowObservationReceivedLogical"},{"x-vmw-nsx-module":"PolicyConnectivity","type":"object","properties":{"component_path":{"readOnly":true,"type":"string","description":"The path of the component that received the traceflow packet","title":"The path of the component that received the traceflow packet"},"segment_port_path":{"readOnly":true,"type":"string","description":"The path of the segment port or router port at which the traceflow packet was received","title":"The path of the segment port or router port at which the traceflow packet was received"},"src_component_path":{"readOnly":true,"type":"string","description":"The path of the source component from which the traceflow packet was received","title":"The path of the source component from which the traceflow packet was received"}}}]},"IPSecVPNLocalEndpointListResult":{"x-vmw-nsx-module":"IPSecVPN","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"IPSecVPN","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/IPSecVPNLocalEndpoint"},"type":"array","description":"IPSec local endpoint list results","title":"IPSec local endpoint list results"}}}],"description":"List all the local endpoints.","title":"List local endpoints"},"MPResourceDetails":{"description":"Contains manager and policy resource id.\n","title":"Contains manager resource details and policy resource id.\n","required":["manager_id"],"x-vmw-nsx-module":"MPPolicyMigration","type":"object","properties":{"policy_path":{"type":"string","description":"Policy resource path.","title":"Policy resource path."},"manager_id":{"type":"string","description":"Manager resource id.","title":"Manager resource id."},"principle_identity":{"type":"string","description":"Principle Identity to be used for MP to Policy promotion in GENERIC workflow.This is internal only.\n","title":"Principle Identity to be used for MP to Policy promotion in GENERIC workflow."},"override":{"type":"boolean","description":"Whether to skip/override the resource in case of multiple resource migration . By default. it will be skip.","title":"Whether to skip/override the resource in case of multiple resource migration . By default. it will be skip."},"policy_id":{"type":"string","description":"Policy resource id.","title":"Policy resource id."},"linked_ids":{"items":{"$ref":"#/definitions/MPResourceLinkedDetails"},"type":"array","description":"Linked resources.\n"},"metadata":{"items":{"$ref":"#/definitions/MPResourceMetadata"},"type":"array","description":"Resource metadata.\n"}}},"FeatureSet":{"x-vmw-nsx-module":"NsxDashboard","type":"object","description":"Represents list of features required to view the widget.","properties":{"feature_list":{"items":{"type":"string"},"type":"array","description":"List of features required for to view widget.","title":"List of features required for to view wdiget"},"require_all_permissions":{"type":"boolean","description":"Flag for specifying if permission to all features is required If set to false, then if there is permission for any of the feature from feature list, widget will be available.","title":"Flag for specifying if permission to all features is required"}},"title":"List of features required to view the widget"},"LbPersistenceCookieTime":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/LbCookieTime"},{"x-vmw-nsx-module":"LoadBalancer","required":["cookie_max_idle"],"type":"object","properties":{"cookie_max_idle":{"description":"HTTP cookie max-age to expire cookie, only available for insert mode.\n","format":"int64","title":"persistence cookie max idle time in seconds","maximum":2147483647,"minimum":1,"type":"integer"}}}]},"FilePropertiesListResult":{"x-vmw-nsx-module":"MISSING_MODULE","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/FileProperties"},"type":"array","description":"File property results","title":"File property results"}}}],"description":"File properties query results","title":"File properties query results"},"Snmpv2cCommunity":{"description":"This object contains SNMP v2c community identifier, shared secret and access properties.","title":"SNMP v2c community","required":["community_name"],"x-vmw-nsx-module":"CentralConfig","type":"object","properties":{"access":{"default":"READ_ONLY","enum":["READ_ONLY"],"type":"string","description":"Access permissions for polling NSX nodes over SNMP v2c.","title":"Type of access"},"community_name":{"minLength":1,"maxLength":64,"type":"string","description":"Unique, non-sensitive community name to identify community.","title":"Community name"},"community_string":{"minLength":1,"maxLength":64,"type":"string","description":"Community string. This is considered a shared secret and therefore sensitive information. This field is required when adding a community. When updating a community, do not include this field in the request. If this field is present in an update request, it will be considered as a new value for community string.","title":"Community string"}}},"IPSecVPNSession":{"x-vmw-nsx-module":"IPSecVPN","allOf":[{"$ref":"#/definitions/ManagedResource"},{"required":["peer_endpoint_id","local_endpoint_id","resource_type"],"discriminator":"resource_type","x-vmw-nsx-module":"IPSecVPN","type":"object","properties":{"peer_endpoint_id":{"type":"string","description":"Peer endpoint identifier.","title":"Peer endpoint identifier"},"ipsec_vpn_service_id":{"readOnly":true,"type":"string","description":"Identifier of VPN Service linked with local endpoint.","title":"IPSec VPN service identifier"},"local_endpoint_id":{"type":"string","description":"Local endpoint identifier.","title":"Local endpoint identifier"},"tcp_mss_clamping":{"$ref":"#/definitions/TcpMssClamping"},"enabled":{"default":true,"type":"boolean","description":"Enable/Disable IPSec VPN session.","title":"Enable/Disable IPSec VPN session"},"resource_type":{"description":"A Policy Based VPN requires to define protect rules that match\n local and peer subnets. IPSec security associations is\n negotiated for each pair of local and peer subnet.\nA Route Based VPN is more flexible, more powerful and recommended over\n policy based VPN. IP Tunnel port is created and all traffic routed via\n tunnel port is protected. Routes can be configured statically\n or can be learned through BGP. A route based VPN is must for establishing\n redundant VPN session to remote site.\n","enum":["PolicyBasedIPSecVPNSession","RouteBasedIPSecVPNSession"],"type":"string"}}}],"description":"VPN session defines connection between local and peer endpoint. Untill VPN session is defined configuration is not realized.","title":"IPSec VPN session"},"ContainerApplicationListResult":{"x-vmw-nsx-module":"InventoryContainerObj","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"InventoryContainerObj","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/ContainerApplication"},"type":"array","description":"List of Container Applications","title":"List of Container Applications"}}}]},"BasePktCapResource":{"discriminator":"resource_type","x-vmw-nsx-module":"LiveTrace","required":["resource_type"],"type":"object","properties":{"resource_type":{"type":"string","description":"Type of packet capture resource","title":"Type of packet capture resource"}}},"VirtualNetworkInterface":{"x-vmw-nsx-module":"Inventory","allOf":[{"$ref":"#/definitions/DiscoveredResource"},{"x-vmw-nsx-module":"Inventory","required":["device_key","owner_vm_id","vm_local_id_on_host","mac_address","host_id","external_id"],"type":"object","properties":{"mac_address":{"type":"string","description":"MAC address of the virtual network interface.","title":"MAC address of the virtual network interface."},"owner_vm_type":{"readOnly":true,"enum":["EDGE","SERVICE","REGULAR"],"type":"string","description":"Owner virtual machine type; Edge, Service VM or other.","title":"Owner virtual machine type; Edge, Service VM or other."},"device_key":{"type":"string","description":"Device key of the virtual network interface.","title":"Device key of the virtual network interface."},"host_id":{"type":"string","description":"Id of the host on which the vm exists.","title":"Id of the host on which the vm exists."},"owner_vm_id":{"type":"string","description":"Id of the vm to which this virtual network interface belongs.","title":"Id of the vm to which this virtual network interface belongs."},"vm_local_id_on_host":{"type":"string","description":"Id of the vm unique within the host.","title":"Id of the vm unique within the host."},"external_id":{"type":"string","description":"External Id of the virtual network inferface.","title":"External Id of the virtual network inferface."},"lport_attachment_id":{"type":"string","description":"LPort Attachment Id of the virtual network interface.","title":"LPort Attachment Id of the virtual network interface."},"ip_address_info":{"items":{"$ref":"#/definitions/IpAddressInfo"},"type":"array","description":"IP Addresses of the the virtual network interface, from various sources.","title":"IP Addresses of the the virtual network interface, from various sources."},"device_name":{"type":"string","description":"Device name of the virtual network interface.","title":"Device name of the virtual network interface."}}}]},"IngressBroadcastRateShaper":{"x-vmw-nsx-module":"QosSwitchingProfile","allOf":[{"$ref":"#/definitions/QosBaseRateShaper"},{"x-vmw-nsx-module":"QosSwitchingProfile","type":"object","properties":{"average_bandwidth_kbps":{"description":"Average bandwidth in kb/s","format":"int32","default":0,"title":"Average bandwidth in kb/s","minimum":0,"type":"integer"},"peak_bandwidth_kbps":{"description":"Peak bandwidth in kb/s","format":"int32","default":0,"title":"Peak bandwidth in kb/s","minimum":0,"type":"integer"},"burst_size_bytes":{"description":"Burst size in bytes","format":"int32","default":0,"title":"Burst size in bytes","minimum":0,"type":"integer"}}}],"description":"A shaper that specifies ingress rate properties in kb/s","title":"A shaper that specifies ingress rate properties in kb/s"},"TransportNodeMemberInfo":{"x-vmw-nsx-module":"TransportZone","type":"object","description":"Information about participating transport nodes","properties":{"host_switches":{"items":{"$ref":"#/definitions/HostSwitchInfo"},"readOnly":true,"type":"array","description":"List of host switches using the transport zone","title":"List of host switches using the transport zone"},"transport_node_display_name":{"readOnly":true,"type":"string","description":"Display name of the transport node which has one or more host switches which belong to associated transport zone.","title":"Display name of the transport node which has one or more host switches which belong to associated transport zone."},"compute_collection_id":{"readOnly":true,"type":"string","description":"Id of the compute collection to which this transport node belongs. Empty if this is standalone transport node or non ESX type node.","title":"Id of the compute collection to which this transport node belongs. Empty if this is standalone transport node or non ESX type node."},"transport_node_id":{"readOnly":true,"type":"string","description":"Id of the transport node which has one or more host switches which belong to associated transport zone.","title":"Id of the transport node which has one or more host switches which belong to associated transport zone."}},"title":"Information about participating transport nodes"},"DSRuleState":{"x-vmw-nsx-module":"DistributedServices","allOf":[{"$ref":"#/definitions/ConfigurationState"},{"x-vmw-nsx-module":"DistributedServices","type":"object","properties":{"revision_desired":{"readOnly":true,"format":"int64","type":"integer","description":"This attribute represents revision number of rule's desired state.","title":"Desired state revision number"}}}],"description":"Rule Realization State","title":"Rule Realization State"},"FeatureUsageCsvRecord":{"x-vmw-nsx-module":"License","allOf":[{"$ref":"#/definitions/CsvRecord"},{"x-vmw-nsx-module":"License","type":"object","properties":{"ccu_usage_count":{"readOnly":true,"format":"int64","type":"integer","description":"count of number of concurrent users","title":"count of number of concurrent users"},"vm_usage_count":{"readOnly":true,"format":"int64","type":"integer","description":"count of number of vms used by this feature","title":"count of number of vms used by this feature"},"vcpu_usage_count":{"readOnly":true,"format":"int64","type":"integer","description":"count of number of vcpus of public cloud VMs","title":"count of number of vcpus of public cloud VMs"},"cpu_usage_count":{"readOnly":true,"format":"int64","type":"integer","description":"count of number of cpu sockets used by this feature","title":"count of number of cpu sockets used by this feature"},"feature":{"readOnly":true,"type":"string","description":"name of the feature","title":"name of the feature"},"core_usage_count":{"readOnly":true,"format":"int64","type":"integer","description":"Number of CPU cores used by this feature","title":"Number of CPU cores used by this feature"}}}]},"DynamicContentFilters":{"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"dynamic_content_filters":{"items":{"type":"string","description":"Support bundle dynamic content filter allowed values, for example, NAPP:SERVICE:PLATFORM_SERVICES"},"type":"array","description":"These filter values will be set by the remote node like the NSX Intelligence Platform for instance. We would not need to know or act on these dynamic content filters, except for passing them on as request parameters along with the support bundle collection API.","title":"Support bundle content filter allowed values"}}},"UpgradeUnitTypeStatsList":{"x-vmw-nsx-module":"Upgrade","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"Upgrade","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/UpgradeUnitTypeStats"},"readOnly":true,"type":"array","description":"List of upgrade unit type stats","title":"List of upgrade unit type stats"}}}]},"PacketCaptureOptionList":{"x-vmw-nsx-module":"PacketCapture","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"PacketCapture","type":"object","properties":{"values":{"items":{"$ref":"#/definitions/PacketCaptureOption"},"type":"array","description":"Packet capture option collection","title":"Packet capture option collection"}}}],"description":"List of packet capture options to filter data in capture process.","title":"List of packet capture options"},"ComponentTargetVersion":{"x-vmw-nsx-module":"Migration","type":"object","properties":{"target_version":{"readOnly":true,"type":"string"},"component_type":{"readOnly":true,"type":"string"}}},"PerNodeUsedCacheStatistics":{"x-vmw-nsx-module":"AggSvcDnsForwarder","type":"object","description":"Query statistics counters of used cache from node\n","properties":{"cached_entries":{"readOnly":true,"format":"int64","type":"integer","description":"The total number of cached entries","title":"The total number of cached entries"},"node_id":{"readOnly":true,"type":"string","description":"Uuid of active/standby transport node","title":"Uuid of active/standby transport node"},"used_cache_size":{"readOnly":true,"format":"int64","type":"integer","description":"The memory size used in cache, in kb","title":"The memory size used in cache, in kb"}},"title":"Per-node used cache query statistics counters"},"HostedEntityInfo":{"x-vmw-nsx-module":"ClusterManagement","type":"object","properties":{"entity_uuid":{"readOnly":true,"type":"string","description":"Unique identifier of entity","title":"Unique identifier of entity"},"entity_type":{"readOnly":true,"type":"string","description":"The type of entity hosted could be MP, CCP, VMC App etc.","title":"Type of entity"}}},"BundleIds":{"x-vmw-nsx-module":"FileUploadFramework","type":"object","description":"Contains a list of bundle-ids.","properties":{"successful":{"readOnly":true,"type":"string","description":"Id of a bundle whose upload is successful.","title":"Sucessful bundle-Id"},"failed":{"readOnly":true,"type":"string","description":"Id of a bundle whose upload was failed.","title":"Failed bundle-Id"},"in_progress":{"readOnly":true,"type":"string","description":"Id of a bundle whose upload is in-progress.","title":"In-progress bundle-Id"}},"title":"List of bundle-ids"},"AllocatedService":{"x-vmw-nsx-module":"EdgeClusters","type":"object","properties":{"service_reference":{"$ref":"#/definitions/ResourceReference"},"high_availability_status":{"readOnly":true,"enum":["ACTIVE","STANDBY","DOWN","SYNC","UNKNOWN"],"type":"string","description":"Represents the active or the standby state of the service.","title":"HA Status of the service context node"},"allocation_details":{"items":{"$ref":"#/definitions/KeyValuePair"},"readOnly":false,"type":"array","description":"Additional properties of a service, say the sub_pool_size and\nsub_pool_type for a LoadBalancer.\n","title":"Key-Value map of additional specific properties of services"}}},"WidgetConfigurationList":{"x-vmw-nsx-module":"NsxDashboard","type":"object","description":"Represents a list of widget configurations.","properties":{"widgetconfigurations":{"items":{"$ref":"#/definitions/WidgetConfiguration"},"readOnly":true,"type":"array","description":"Array of widget configurations","title":"Array of widget configurations"}},"title":"List of Widget Configurations"},"LbVirtualServerStatusListResult":{"x-vmw-nsx-module":"AggSvcLb","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"AggSvcLb","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/LbVirtualServerStatus"},"type":"array","description":"paginated status list of virtual servers","title":"paginated status list of virtual servers"}}}]},"DnsAnswer":{"description":"The response for DNS nslookup.\n","title":"Answer of dns nslookup","required":["edge_node_id","dns_server","source_ip"],"x-vmw-nsx-module":"DnsForwarder","type":"object","properties":{"dns_server":{"type":"string","description":"Dns server ip address and port, format is \"ip address#port\".\n","title":"DNS server information"},"raw_answer":{"type":"string","description":"It can be NXDOMAIN or error message which is not consisted of\nauthoritative_answer or non_authoritative_answer.\n","title":"Raw message returned from the DNS forwarder"},"non_authoritative_answers":{"description":"Non-authotitative answers of the query.\nThis is a deprecated property, please use 'answers' instead.\n","title":"Non authoritative answers","minItems":1,"items":{"$ref":"#/definitions/DnsQueryAnswer"},"x-deprecated":true,"maxItems":256,"type":"array"},"source_ip":{"description":"The source ip used in this lookup.\n","format":"ipv4","type":"string"},"edge_node_id":{"type":"string","description":"ID of the edge node that performed the query.\n","title":"Edge node id"},"authoritative_answers":{"description":"Authotitative answers of the query.\nThis is a deprecated property, please use 'answers' instead.\n","title":"Authoritative answers","minItems":1,"items":{"$ref":"#/definitions/DnsQueryAnswer"},"x-deprecated":true,"maxItems":256,"type":"array"},"answers":{"description":"The answers of the query.\n","title":"The answers of the query.","minItems":1,"items":{"$ref":"#/definitions/DnsQueryAnswer"},"maxItems":256,"type":"array"}}},"PnicBondStatusListResult":{"x-vmw-nsx-module":"Heatmap","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"Heatmap","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/PnicBondStatus"},"type":"array","description":"List of pNIC statuses belonging to the transport node","title":"List of pNIC/bond statuses"}}}],"description":"This object contains reference to list of pNIC/bond statuses","title":"pNIC status list container"},"IPSecVPNSessionTrafficSummary":{"x-vmw-nsx-module":"VPNStatistics","type":"object","description":"IPSec VPN session traffic summary.","properties":{"traffic_counters":{"$ref":"#/definitions/IPSecVPNTrafficCounters"},"ipsec_vpn_session":{"$ref":"#/definitions/ResourceReference"}},"title":"IPSec VPN session traffic summary"},"ApplianceManagementTaskListResult":{"x-vmw-nsx-module":"MISSING_MODULE","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/ApplianceManagementTaskProperties"},"type":"array","description":"Task property results","title":"Task property results"}}}],"description":"Appliance management task query results","title":"Appliance management task query results"},"AllocationBasedOnFailureDomain":{"x-vmw-nsx-module":"EdgeClusters","allOf":[{"$ref":"#/definitions/AllocationRuleAction"},{"x-vmw-nsx-module":"EdgeClusters","type":"object","properties":{"enabled":{"default":false,"type":"boolean","description":"Enable placement algorithm to consider failure domain of edge transport\nnodes and place active and standby contexts in different failure domains.\n","title":"Flag to enable failure domain based allocation"}}}],"description":"Auto place TIER1 logical routers, DHCP and MDProxy contexts on two edge\nnodes (active and standby) from different failure domains.\n","title":"Placement based on failure domain of edge node"},"CapacityUsageMetaInfo":{"x-vmw-nsx-module":"CapacityDashboard","required":["max_global_threshold_percentage","min_global_threshold_percentage","last_updated_timestamp"],"type":"object","properties":{"max_global_threshold_percentage":{"type":"number","description":"Indicates the maximum global threshold percentage\n","title":"Maximum global threshold percentage"},"min_global_threshold_percentage":{"type":"number","description":"Indicates the minimum global threshold percentage\n","title":"Minimum global threshold percentage"},"last_updated_timestamp":{"type":"integer","description":"Timestamp at which capacity usage was last calculated","format":"int64"}}},"VniPool":{"x-vmw-nsx-module":"Vnim","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"Vnim","required":["ranges"],"type":"object","properties":{"ranges":{"items":{"$ref":"#/definitions/VniRange"},"type":"array","description":"VNI range list results","title":"VNI range list results"}}}]},"IPSecVPNSessionSummary":{"x-vmw-nsx-module":"VPNStatistics","type":"object","description":"Summarized view of all selected IPSec VPN sessions.","properties":{"traffic_summary_per_session":{"items":{"$ref":"#/definitions/IPSecVPNSessionTrafficSummary"},"type":"array","description":"Traffic summary per session.","title":"Traffic summary"},"last_update_timestamp":{"description":"Timestamp when the data was last updated.","format":"int64","readOnly":true,"type":"integer"},"session_summary":{"$ref":"#/definitions/IPsecVPNIKESessionSummary"},"aggregate_traffic_counters":{"$ref":"#/definitions/IPSecVPNTrafficCounters"}},"title":"IPSec VPN session summary"},"FirewallSectionLock":{"x-vmw-nsx-module":"Firewall","required":["comments","section_revision"],"type":"object","properties":{"comments":{"description":"Comments for section lock/unlock.","title":"Comments","minLength":4,"readOnly":false,"maxLength":4096,"type":"string"},"section_revision":{"readOnly":false,"format":"int64","type":"integer","description":"Revision of the section.","title":"Section revision"}}},"LbRuleCondition":{"description":"Match conditions are used to match application traffic passing through\nload balancers. Multiple match conditions can be specified in one load\nbalancer rule, each match condition defines a criterion for application\ntraffic.\nIf inverse field is set to true, the match result of the condition is\ninverted.\nIf more than one match condition is specified, match strategy determines\nif all conditions should match or any one condition should match for the\nload balancer rule to be considered a match.\nCurrently only HTTP messages are supported by load balancer rules.\nEach load balancer rule is used at a specific phase of load balancer\nprocessing. Currently three phases are supported, HTTP_REQUEST_REWRITE,\nHTTP_FORWARDING and HTTP_RESPONSE_REWRITE.\nEach phase supports certain types of match conditions, supported match\nconditions in HTTP_REQUEST_REWRITE phase are:\nLbHttpRequestMethodCondition\nLbHttpRequestUriCondition\nLbHttpRequestUriArgumentsCondition\nLbHttpRequestVersionCondition\nLbHttpRequestHeaderCondition\nLbHttpRequestCookieCondition\nLbHttpRequestBodyCondition\nLbTcpHeaderCondition\nLbIpHeaderCondition\nLbVariableCondition\nLbHttpSslCondition\nSupported match conditions in HTTP_FORWARDING phase are:\nLbHttpRequestMethodCondition\nLbHttpRequestUriCondition\nLbHttpRequestUriArgumentsCondition\nLbHttpRequestVersionCondition\nLbHttpRequestHeaderCondition\nLbHttpRequestCookieCondition\nLbHttpRequestBodyCondition\nLbTcpHeaderCondition\nLbIpHeaderCondition\nLbVariableCondition\nLbHttpSslCondition\nLbSslSniCondition\nSupported match condition in HTTP_RESPONSE_REWRITE phase is:\nLbHttpResponseHeaderCondition\nLbHttpRequestMethodCondition\nLbHttpRequestUriCondition\nLbHttpRequestUriArgumentsCondition\nLbHttpRequestVersionCondition\nLbHttpRequestHeaderCondition\nLbHttpRequestCookieCondition\nLbTcpHeaderCondition\nLbIpHeaderCondition\nLbVariableCondition\nLbHttpSslCondition\nSupported match condition in HTTP_ACCESS phase is:\nLbHttpRequestMethodCondition\nLbHttpRequestUriCondition\nLbHttpRequestUriArgumentsCondition\nLbHttpRequestVersionCondition\nLbHttpRequestHeaderCondition\nLbHttpRequestCookieCondition\nLbHttpRequestBodyCondition\nLbTcpHeaderCondition\nLbIpHeaderCondition\nLbVariableCondition\nLbHttpSslCondition\nSupported match condition in TRANSPORT phase is:\nLbSslSniCondition\n","title":"Match condition of load balancer rule","required":["type"],"discriminator":"type","x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"inverse":{"default":false,"type":"boolean","description":"A flag to indicate whether reverse the match result of this condition","title":"A flag to indicate whether reverse the match result of this condition"},"type":{"description":"Type of load balancer rule condition","enum":["LbHttpRequestMethodCondition","LbHttpRequestUriCondition","LbHttpRequestUriArgumentsCondition","LbHttpRequestVersionCondition","LbHttpRequestHeaderCondition","LbHttpRequestCookieCondition","LbHttpRequestBodyCondition","LbHttpResponseHeaderCondition","LbTcpHeaderCondition","LbIpHeaderCondition","LbVariableCondition","LbHttpSslCondition","LbSslSniCondition"],"type":"string"}}},"ClusteringConfig":{"description":"Configuration for automatically joining a cluster node to the\ncluster after it is deployed. ClusteringConfig is required\nif any of the deployment nodes has CONTROLLER role.\n","title":"Configuration for VM's clustering","required":["clustering_type"],"discriminator":"clustering_type","x-vmw-nsx-module":"ClusterNodeVMDeployment","type":"object","properties":{"clustering_type":{"enum":["ControlClusteringConfig"],"type":"string","description":"Specifies the type of clustering config to be used.\n","title":"Type for the clustering config"}}},"L2VpnTcpMssClamping":{"x-vmw-nsx-module":"L2VPN","type":"object","description":"TCP MSS Clamping Direction and value for L2VPN session.","properties":{"max_segment_size":{"description":"It defines the maximum amount of data that a host is willing to accept in a single TCP segment. This field is set in TCP header during connection establishment. To avoid packet fragmentation, you can set this field depending on uplink MTU and VPN overhead. This is optional field and in case it is left unconfigured, best possible MSS value will be calculated based on effective mtu of uplink interface. Supported MSS range is 108 to 8860.","format":"int64","title":"Maximum Segment Size value","maximum":8860,"minimum":108,"type":"integer"},"direction":{"default":"BOTH","enum":["NONE","BOTH"],"type":"string","description":"Specifies the traffic direction for which to apply MSS Clamping. If direction is None, the feature is disabled.","title":"MSS Clamping direction"}},"title":"TCP MSS Clamping Object for L2VPN Session"},"UpgradeTaskProperties":{"description":"Task properties","title":"Task properties","required":["bundle_name"],"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"bundle_name":{"type":"string","description":"Name of Bundle","title":"Name of Bundle"},"step":{"type":"string","description":"Step name","title":"Step name"},"parameters":{"readOnly":true,"type":"object","description":"Bundle arguments","title":"Bundle arguments"}}},"IPSecVPNTunnelProfile":{"x-vmw-nsx-module":"IPSecVPN","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"IPSecVPN","type":"object","properties":{"encapsulation_mode":{"description":"Encapsulation Mode to be used for encryption of packet. Tunnel mode protects internal routing information by encrypting IP header of original packet.","title":"Encapsulation Mode","default":"TUNNEL_MODE","enum":["TUNNEL_MODE"],"readOnly":true,"type":"string"},"transform_protocol":{"description":"IPSec transform specifies IPSec security protocol.","title":"Tunnel protocol","default":"ESP","enum":["ESP"],"readOnly":true,"type":"string"},"digest_algorithms":{"items":{"description":"The TunnelDigestAlgorithms are used to verify message\nintegrity during IPSec VPN tunnel establishment.\nSHA1 produces 160 bits hash and SHA2_XXX produces\nXXX bit hash.\n","enum":["SHA1","SHA2_256","SHA2_384","SHA2_512"],"type":"string"},"type":"array","description":"Algorithm to be used for message digest. Default digest algorithm is implicitly covered by default encryption algorithm \"AES_GCM_128\".","title":"Algorithm for message hash"},"encryption_algorithms":{"items":{"description":"TunnelEncryption algorithms are used to ensure confidentiality\nof the messages exchanged during Tunnel negotiations. AES\nstands for Advanced Encryption Standards. AES_128 uses 128-bit\nkeys whereas AES_256 uses 256-bit keys for encryption and\ndecryption. AES_128 and AES_256 use CBC mode of encryption.\nAES_GCM stands for Advanced Encryption Standard(AES) in\nGalois/Counter Mode (GCM) and is used to provide both\nconfidentiality and data origin authentication.\nNO_ENCRYPTION_AUTH_AES_GMAC_* enables authentication on input\ndata without encyption. Digest algorithm should be empty for this\noption.\n","enum":["AES_128","AES_256","AES_GCM_128","AES_GCM_192","AES_GCM_256","NO_ENCRYPTION_AUTH_AES_GMAC_128","NO_ENCRYPTION_AUTH_AES_GMAC_192","NO_ENCRYPTION_AUTH_AES_GMAC_256","NO_ENCRYPTION"],"type":"string"},"type":"array","description":"Encryption algorithm to encrypt/decrypt the messages exchanged between IPSec VPN initiator and responder during tunnel negotiation. Default is AES_GCM_128.","title":"Encryption algorithm to use in tunnel establishement"},"enable_perfect_forward_secrecy":{"default":true,"type":"boolean","description":"If true, perfect forward secrecy (PFS) is enabled.","title":"Enable perfect forward secrecy"},"dh_groups":{"items":{"description":"Diffie-Hellman groups represent algorithm used to derive shared\nkeys between IPSec VPN initiator and responder over an\nunsecured network.\nGROUP2 uses 1024-bit Modular Exponentiation (MODP) group.\nGROUP5 uses 1536-bit MODP group.\nGROUP14 uses 2048-bit MODP group.\nGROUP15 uses 3072-bit MODP group.\nGROUP16 uses 4096-bit MODP group.\nGROUP19 uses 256-bit random Elliptic Curve (ECP) group.\nGROUP20 uses 384-bit random ECP group.\nGROUP21 uses 521-bit random ECP group.\n","enum":["GROUP2","GROUP5","GROUP14","GROUP15","GROUP16","GROUP19","GROUP20","GROUP21"],"type":"string"},"type":"array","description":"Diffie-Hellman group to be used if PFS is enabled. Default is GROUP14.","title":"DH group"},"df_policy":{"default":"COPY","enum":["COPY","CLEAR"],"type":"string","description":"Defragmentation policy helps to handle defragmentation bit present in the inner packet. COPY copies the defragmentation bit from the inner IP packet into the outer packet. CLEAR ignores the defragmentation bit present in the inner packet.","title":"Policy for handling defragmentation bit"},"sa_life_time":{"description":"SA life time specifies the expiry time of security\nassociation. Default is 3600 seconds.\n","title":"Security association (SA) life time","default":3600,"format":"int64","maximum":31536000,"minimum":900,"type":"integer"}}}],"description":"IPSec VPN tunnel profile is a reusable profile that captures phase two negotiation parameters and tunnel properties. Any changes affects all IPSec VPN sessions consuming this profile.","title":"IPSec VPN tunnel profile"},"ManagementPlaneBrokerProperties":{"description":"Information about a management plane node this controller is configured to communicate with","title":"Information about a management plane node this controller is configured to communicate with","required":["host","thumbprint"],"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"host":{"description":"IP address or hostname of the message bus broker on the management plane node.","format":"hostname-or-ipv4","readOnly":false,"type":"string"},"port":{"description":"Port number of the message bus broker on the management plane node.","format":"int64","default":5671,"maximum":65535,"minimum":0,"type":"integer"},"thumbprint":{"type":"string","description":"Certificate thumbprint of the message bus broker on the management plane node."}}},"LbAppProfileListResult":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"LoadBalancer","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/LbAppProfile"},"type":"array","description":"paginated list of load balancer application profiles","title":"paginated list of load balancer application profiles"}}}]},"RevisionedResource":{"x-vmw-nsx-module":"Common","allOf":[{"$ref":"#/definitions/Resource"},{"x-vmw-nsx-module":"Common","type":"object","properties":{"_revision":{"format":"int32","type":"integer","description":"The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.","title":"Generation of this resource config"}}}],"description":"A base class for types that track revisions","title":"A base class for types that track revisions"},"MsgClientInfo":{"x-vmw-nsx-module":"Common","type":"object","description":"Information about a messaging client","properties":{"software_version":{"readOnly":true,"type":"string","description":"Software version of the node."},"account_name":{"readOnly":false,"type":"string","description":"Account name for the messaging client. Identifies the client on the management plane message bus."},"certificate":{"readOnly":false,"type":"string","description":"Messaging client's certificate. Used to authenticate to the control plane messaging endpoint."},"shared_secret":{"readOnly":false,"type":"string","description":"Messaging client's secret. Used to authenticate to the management plane messaging broker."}},"title":"Information about a messaging client"},"IdsVmStats":{"x-vmw-nsx-module":"IDSMetrics","type":"object","description":"List of VMs on which a particular signature was detected with the count.\n","properties":{"count":{"readOnly":true,"format":"int64","type":"integer","description":"Number of unique VMs on which a particular signature was detected.","title":"Number of unique VMs"},"vm_list":{"items":{"type":"string"},"readOnly":true,"type":"array","description":"List of VM names on which intrusions of that particular signature type were detected.","title":"List of VM names"}},"title":"List of VMs where signature was detected"},"LbConnectionDropAction":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/LbRuleAction"},{"x-vmw-nsx-module":"LoadBalancer","type":"object"}],"description":"This action is used to drop the connections. There is no extra propery in\nthis action. If there is no match condition specified, the connection will\nbe always dropped. This action can be specified at HTTP_ACCESS or\nHTTP_FORWARDING pahse.\n","title":"Action to drop connections"},"TraceActionArgument":{"x-vmw-nsx-module":"LiveTrace","type":"object","properties":{"reverse_filter":{"$ref":"#/definitions/LiveTraceFilterData"},"dest_lport":{"readOnly":true,"type":"string","description":"It is required only when the type of trace is bidirectional. Please keep this field aligned with the\ndestination logical port of packet capture action config when the type of packet capture action is bidirectional.\n","title":"Destination logical port for bidirectional trace"},"trace_type":{"readOnly":true,"enum":["UNI_DIRECTIONAL","BI_DIRECTIONAL"],"type":"string","description":"Type of trace","title":"Type of trace"}}},"HostUpgradeStatus":{"x-vmw-nsx-module":"Upgrade","allOf":[{"$ref":"#/definitions/ComponentUpgradeStatus"},{"x-vmw-nsx-module":"Upgrade","type":"object"}],"description":"Status of host upgrade","title":"Status of host upgrade"},"FeedBackListResult":{"x-vmw-nsx-module":"MPPolicyMigration","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"MPPolicyMigration","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/FeedBack"},"type":"array","description":"Feedback object list results.\n","title":"Feedback object list results."}}}]},"VIPSubnet":{"x-vmw-nsx-module":"LogicalRouter","required":["prefix_length","active_vip_addresses"],"type":"object","properties":{"prefix_length":{"description":"Subnet Prefix Length","format":"int64","title":"Subnet Prefix Length","maximum":128,"minimum":1,"type":"integer"},"active_vip_addresses":{"description":"Array of IP address subnets which will be used as floating IP addresses. | These IPs will move and will be owned by Active node.","title":"IP Addresses which will be owned by uplink on active node.","minItems":1,"items":{"description":"IPv4 or IPv6 address","format":"ip","type":"string"},"maxItems":1,"type":"array"}}},"IdfwTransportNodeCondition":{"description":"Status of the Identity Firewall Compute Collection's transport node.\n","title":"IDFW transport node status.","required":["status"],"x-vmw-nsx-module":"IdentityFirewall","type":"object","properties":{"status":{"enum":["UNKNOWN","UP","DOWN","NOT_PREPARED","IDFW_COMPONENT_NOT_INSTALLED","DFW_DISABLED","IDFW_DISABLED"],"type":"string","description":"Transport node status for IDFW compute collection.","title":"IDFW TransportNode status."},"status_detail":{"type":"string","description":"IDFW Compute collection's transport node condition.","title":"IDFW transport node condition."}}},"CurrentBackupOperationStatus":{"x-vmw-nsx-module":"BackupConfiguration","type":"object","description":"Current backup operation status","properties":{"current_step":{"enum":["BACKUP_CREATING_CLUSTER_BACKUP","BACKUP_CREATING_NODE_BACKUP"],"type":"string","description":"Current step of operation","title":"Current step of operation"},"backup_id":{"type":"string","description":"Unique identifier of current backup","title":"Unique identifier of current backup"},"current_step_message":{"type":"string","description":"Additional human-readable status information about current step","title":"Additional human-readable status information about current step"},"end_time":{"type":"integer","description":"Time when operation is expected to end","format":"int64"},"operation_type":{"enum":["NONE","BACKUP"],"type":"string","description":"Type of operation that is in progress. Returns none if no operation is in progress, in which case\nnone of the other fields will be set.\n","title":"Type of operation that is in progress. Returns none if no operation is in progress, in which case\nnone of the other fields will be set.\n"},"start_time":{"type":"integer","description":"Time when operation was started","format":"int64"}},"title":"Current backup operation status"},"LiveTraceRequest":{"x-vmw-nsx-module":"LiveTrace","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"LiveTrace","type":"object","properties":{"filter":{"$ref":"#/definitions/LiveTraceFilterData"},"timeout":{"description":"Timeout in seconds for livetrace session","title":"Timeout in seconds for livetrace session","default":10,"format":"int64","maximum":300,"minimum":5,"type":"integer"},"actions":{"$ref":"#/definitions/LiveTraceActionConfig"},"source_lport":{"readOnly":true,"type":"string","description":"Source logical port","title":"Source logical port"}}}]},"LogicalPortOperationalStatus":{"x-vmw-nsx-module":"AggSvcLogicalPort","required":["status"],"type":"object","properties":{"logical_port_id":{"readOnly":true,"type":"string","description":"The id of the logical port","title":"The id of the logical port"},"status":{"enum":["UP","DOWN","UNKNOWN"],"type":"string","description":"The Operational status of the logical port","title":"The Operational status of the logical port"},"last_update_timestamp":{"description":"Timestamp when the data was last updated; unset if data source has never updated the data.","format":"int64","readOnly":true,"type":"integer"}}},"MacTableCsvRecord":{"x-vmw-nsx-module":"AggSvcLogicalSwitch","allOf":[{"$ref":"#/definitions/CsvRecord"},{"x-vmw-nsx-module":"AggSvcLogicalSwitch","required":["mac_address"],"type":"object","properties":{"vtep_mac_address":{"type":"string","description":"The virtual tunnel endpoint MAC address","title":"The virtual tunnel endpoint MAC address"},"rtep_group_id":{"format":"int64","type":"integer","description":"RTEP group id is applicable when the logical switch is stretched\nacross multiple sites. When rtep_group_id is set, mac_address\nrepresents remote mac_address.\n","title":"Remote tunnel endpoint(RTEP) group id"},"vtep_ip":{"description":"The virtual tunnel endpoint IP address","format":"ip","type":"string"},"vtep_group_id":{"format":"int64","type":"integer","description":"VTEP group id is applicable when the logical switch is stretched\nacross multiple sites. When vtep_group_id is set, mac_address\nrepresents remote mac_address.\n","title":"Virtual tunnel endpoint(VTEP) group id"},"mac_address":{"type":"string","description":"The MAC address","title":"The MAC address"}}}]},"DirectoryLdapServerStatus":{"x-vmw-nsx-module":"DirectoryService","type":"object","description":"Status LDAP server of directory domain","properties":{"error_id":{"format":"int64","type":"integer","description":"Error ID of the directory LDAP server status maintained by the NSX directory service.","title":"Error ID of the directory LDAP server status"},"error_message":{"type":"string","description":"Error message of the directory LDAP server status maintained by the NSX directory service.","title":"Error message of the directory LDAP server status"}},"title":"Status LDAP server of directory domain"},"RuntimeInterfaceOperationalStatus":{"x-vmw-nsx-module":"ServiceInsertionVMDeployment","required":["status"],"type":"object","properties":{"status":{"enum":["UP","DOWN","UNKNOWN"],"type":"string","description":"The Operational status of the interface","title":"The Operational status of the interface"},"last_update_timestamp":{"description":"Timestamp when the data was last updated; unset if data source has never updated the data.","format":"int64","readOnly":true,"type":"integer"},"interface_index":{"readOnly":true,"format":"int64","type":"integer","description":"Index of the interface","title":"Index of the interface"}}},"ContainerClusterNode":{"x-vmw-nsx-module":"InventoryContainerObj","allOf":[{"$ref":"#/definitions/DiscoveredResource"},{"required":["external_id"],"x-vmw-nsx-module":"InventoryContainerObj","type":"object","properties":{"network_status":{"readOnly":false,"enum":["HEALTHY","UNHEALTHY"],"type":"string","description":"Network status of container cluster node.","title":"Network status of container cluster node"},"provider_id":{"readOnly":false,"type":"string","description":"Specifies identifier of container cluster node given by infrastructure provider\nof container cluster. e.g. in case of vSpehere, it will be instance uuid of worker\nnode virtual machine.\n","title":"Provider id of container node"},"cni_agent_status":{"readOnly":false,"enum":["HEALTHY","UNHEALTHY"],"type":"string","description":"Specifies Container Network Interface agent status of container cluster node.","title":"CNI agent status of container cluster node"},"ip_addresses":{"items":{"description":"IPv4 or IPv6 address","format":"ip","type":"string"},"readOnly":false,"type":"array","description":"List of IP addresses of container cluster node.","title":"IP Addresses of Node"},"origin_properties":{"items":{"$ref":"#/definitions/KeyValuePair"},"readOnly":false,"type":"array","description":"Array of additional specific properties of container cluster node\nin key-value format.\n","title":"Origin properties"},"external_id":{"readOnly":false,"type":"string","description":"External identifier of the container cluster node in K8S/PAS.\n","title":"External identifier of the container cluster node"},"container_cluster_id":{"readOnly":false,"type":"string","description":"External identifier of the container cluster.","title":"External identifier of the container cluster"},"network_errors":{"items":{"$ref":"#/definitions/NetworkError"},"readOnly":false,"type":"array","description":"List of network errors related to container cluster node.","title":"Network errors"}}}],"description":"Details of container cluster node i.e. container host.","title":"Container cluster node"},"DhcpLeasePerIP":{"x-vmw-nsx-module":"AggSvcDhcp","required":["start_time","ip_address","mac_address"],"type":"object","properties":{"subnet":{"type":"string","description":"subnet of client network","title":"subnet of client network"},"lease_time":{"type":"string","description":"lease time of the ip address, in seconds","title":"lease time of the ip address, in seconds"},"mac_address":{"type":"string","description":"mac address of client","title":"mac address of client"},"expire_time":{"type":"string","description":"expire time of the lease","title":"expire time of the lease"},"start_time":{"type":"string","description":"start time of lease","title":"start time of lease"},"ip_address":{"type":"string","description":"ip address of client","title":"ip address of client"}}},"RemoteTunnelStatisticsPerSite":{"x-vmw-nsx-module":"AggSvcInterSite","type":"object","properties":{"stats_per_tunnel":{"items":{"$ref":"#/definitions/RemoteTunnelStatistics"},"readOnly":true,"type":"array","description":"Statistics per remote tunnel.","title":"Statistics per remote tunnel"},"remote_site":{"$ref":"#/definitions/ResourceReference"},"rx":{"$ref":"#/definitions/InterSitePortCounters"},"tx":{"$ref":"#/definitions/InterSitePortCounters"}}},"IdsUserStats":{"x-vmw-nsx-module":"IDSMetrics","type":"object","description":"List of Users logged into VMs where intrusions of a given signature\nwere detected.\n","properties":{"count":{"readOnly":true,"format":"int64","type":"integer","description":"Number of unique users logged into VMs on which a particular signature was detected.","title":"Number of unique users"},"user_list":{"items":{"type":"string"},"readOnly":true,"type":"array","description":"List of users logged into VMs on which a particular signature was detected.","title":"List of users"}},"title":"List of Users"},"LbEdgeNodeUsage":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/LbNodeUsage"},{"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"current_credit_number":{"readOnly":true,"format":"int64","type":"integer","description":"The current credit number reflects the current usage on the node.\nFor example, configuring a medium load balancer on a node consumes\n10 credits. If there are 2 medium instances configured on a node,\nthe current credit number is 2 * 10 = 20.\n","title":"Current credit number"},"form_factor":{"readOnly":true,"enum":["SMALL_VIRTUAL_MACHINE","MEDIUM_VIRTUAL_MACHINE","LARGE_VIRTUAL_MACHINE","XLARGE_VIRTUAL_MACHINE","PHYSICAL_MACHINE"],"type":"string","description":"The form factor of the given edge node.\n","title":"The form factor of the given edge node"},"current_virtual_servers":{"readOnly":true,"format":"int64","type":"integer","description":"The number of virtual servers configured on the node.\n","title":"The current number of virtual servers"},"current_small_load_balancer_services":{"readOnly":true,"format":"int64","type":"integer","description":"The number of small load balancer services configured on the node.\n","title":"The current number of small load balancer services"},"current_pool_members":{"readOnly":true,"format":"int64","type":"integer","description":"The number of pool members configured on the node.\n","title":"The current number of pool members"},"severity":{"description":"The severity calculation is based on current credit usage percentage\nof load balancer for one node.\n","enum":["GREEN","ORANGE","RED"],"readOnly":true,"type":"string"},"current_pools":{"readOnly":true,"format":"int64","type":"integer","description":"The number of pools configured on the node.\n","title":"The current number of pools"},"remaining_pool_members":{"readOnly":true,"format":"int64","type":"integer","description":"The remaining number of pool members which could be configured on the\ngiven edge node.\n","title":"The remaining number of pool members"},"edge_cluster_id":{"readOnly":true,"type":"string","description":"The ID of edge cluster which contains the edge node.\n","title":"The ID of edge cluster"},"remaining_xlarge_load_balancer_services":{"readOnly":true,"format":"int64","type":"integer","description":"The remaining number of xlarge load balancer services which could be\nconfigured on the given edge node.\n","title":"The remaining number of xlarge load balancer services"},"remaining_small_load_balancer_services":{"readOnly":true,"format":"int64","type":"integer","description":"The remaining number of small load balancer services which could be\nconfigured on the given edge node.\n","title":"The remaining number of small load balancer services"},"current_xlarge_load_balancer_services":{"readOnly":true,"format":"int64","type":"integer","description":"The number of xlarge load balancer services configured on the node.\n","title":"The current number of xlarge load balancer services"},"usage_percentage":{"readOnly":true,"type":"number","description":"The usage percentage of the edge node for load balancer.\nThe value is the larger value between load balancer credit usage\npercentage and pool member usage percentage for the edge node.\n","title":"Usage percentage"},"current_large_load_balancer_services":{"readOnly":true,"format":"int64","type":"integer","description":"The number of large load balancer services configured on the node.\n","title":"The current number of large load balancer services"},"remaining_credit_number":{"readOnly":true,"format":"int64","type":"integer","description":"The remaining credit number is the remaining credits that can be used\nfor load balancer service configuration. For example, an edge node with\nform factor LARGE_VIRTUAL_MACHINE has 40 credits, and a medium\nload balancer instance costs 10 credits. If there are currently\n3 medium instances configured, the remaining credit number is\n40 - (3 * 10) = 10.\n","title":"Remaining credit number"},"remaining_large_load_balancer_services":{"readOnly":true,"format":"int64","type":"integer","description":"The remaining number of large load balancer services which could be\nconfigured on the given edge node.\n","title":"The remaining number of large load balancer services"},"remaining_medium_load_balancer_services":{"readOnly":true,"format":"int64","type":"integer","description":"The remaining number of medium load balancer services which could be\nconfigured on the given edge node.\n","title":"The remaining number of medium load balancer services"},"current_medium_load_balancer_services":{"readOnly":true,"format":"int64","type":"integer","description":"The number of medium load balancer services configured on the node.\n","title":"The current number of medium load balancer services"}}}],"description":"The capacity contains basic information and load balancer entity usages\nand capacity for the given edge node.\n","title":"The load balancer usage for an edge node"},"Oauth2Credentials":{"description":"Oauth2 Account Credentials","title":"Oauth2 Account Credentials","required":["client_id"],"x-vmw-nsx-module":"ApplianceModes","type":"object","properties":{"client_secret":{"type":"string","description":"Client secret, that will be used for authentication in AWS environment. Can be some passphrase.","title":"Client Secret"},"client_id":{"type":"string","description":"Client ID, that will be used for authentication in AWS environment,","title":"Client ID"}}},"ClusterVirtualIpProperties":{"description":"Cluster virtual IP properties","title":"Cluster virtual IP properties","required":["ip_address"],"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"ip_address":{"type":"string","description":"Virtual IP address, 0.0.0.0 if not configured","title":"Virtual IP address, 0.0.0.0 if not configured"}}},"SwitchSecuritySwitchingProfile":{"x-vmw-nsx-module":"SwitchSecuritySwitchingProfile","allOf":[{"$ref":"#/definitions/BaseSwitchingProfile"},{"x-vmw-nsx-module":"SwitchSecuritySwitchingProfile","type":"object","properties":{"bpdu_filter":{"$ref":"#/definitions/BpduFilter"},"rate_limits":{"$ref":"#/definitions/RateLimits"},"ra_guard_enabled":{"default":true,"readOnly":false,"type":"boolean","description":"RA Guard when enabled blocks unauthorized/rogue Router Advertisement (RA) packets.","title":"Indicates whether ra guard should be enabled"},"dhcp_filter":{"$ref":"#/definitions/DhcpFilter"},"block_non_ip_traffic":{"default":false,"readOnly":false,"type":"boolean","description":"A flag to block all traffic except IP/(G)ARP/BPDU","title":"A flag to block all traffic except IP/(G)ARP/BPDU"}}}]},"SetupDetails":{"x-vmw-nsx-module":"MPPolicyMigration","type":"object","description":"Contains Setup details of nsx appliance.\n","properties":{"principal_identity":{"type":"string","description":"User principal.\n","title":"User principal."}},"title":"Setup details of nsx appliance.\n"},"RAConfig":{"x-vmw-nsx-module":"Routing","type":"object","properties":{"router_lifetime":{"description":"Router lifetime value in seconds. A value of 0 indicates the\nrouter is not a default router for the receiving end. Any other value\nin this field specifies the lifetime, in seconds, associated with\nthis router as a default router.\n","title":"Lifetime of router","default":1800,"format":"int64","maximum":65520,"minimum":0,"type":"integer"},"ra_interval":{"description":"Interval between 2 Router advertisement in seconds.\n","title":"RA interval","default":600,"format":"int64","maximum":1800,"minimum":4,"type":"integer"},"prefix_preferred_time":{"description":"The time interval in seconds, in which the prefix is advertised\nas preferred.\n","title":"Prefix preferred time","default":604800,"format":"int64","maximum":4294967295,"minimum":0,"type":"integer"},"hop_limit":{"description":"The maximum number of hops through which packets can\npass before being discarded.\n","title":"Hop limit","default":64,"format":"int64","maximum":255,"minimum":0,"type":"integer"},"prefix_lifetime":{"description":"The time interval in seconds, in which the prefix is advertised\nas valid.\n","title":"Lifetime of prefix","default":2592000,"format":"int64","maximum":4294967295,"minimum":0,"type":"integer"},"router_preference":{"description":"NDRA Router preference value with MEDIUM as default. If the router_lifetime is 0,\nthe preference must be set to MEDIUM.\n","default":"MEDIUM","enum":["LOW","MEDIUM","HIGH","RESERVED"],"type":"string"}}},"SwitchingProfilesListResult":{"x-vmw-nsx-module":"BaseSwitchingProfile","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"BaseSwitchingProfile","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/BaseSwitchingProfile"},"readOnly":true,"type":"array","description":"Switching Profile Results","title":"Switching Profile Results"}}}],"description":"Switching Profile queries result","title":"Switching Profile queries result"},"CertificateKeyPair":{"x-vmw-nsx-module":"MISSING_MODULE","required":["certificate"],"type":"object","properties":{"rsa_private_key":{"minLength":60,"readOnly":false,"type":"string","description":"The private key must include the enclosing \"-----BEGIN RSA PRIVATE KEY-----\" and \"-----END RSA PRIVATE KEY-----\". An empty string is returned in read responses.","title":"PEM encoded RSA private key"},"certificate":{"$ref":"#/definitions/SecurityCertificate"}}},"CustomWidgetConfiguration":{"x-vmw-nsx-module":"NsxDashboard","allOf":[{"$ref":"#/definitions/WidgetConfiguration"},{"x-vmw-nsx-module":"NsxDashboard","type":"object","properties":{"ui_component_identifier":{"type":"string","description":"User defined component selector to be rendered inside view/container.","title":"UI identifier for component to be rendered inside view/container"}}}],"description":"Represents configuration for custom widget. For this widget the data source is not applicable. It defines ui identifer to identify UI component and render it on dashboard view. This configuration can only be used for system owned widgets.","title":"Custom widget Configuration"},"UpgradeUnit":{"x-vmw-nsx-module":"Upgrade","allOf":[{"$ref":"#/definitions/Resource"},{"x-vmw-nsx-module":"Upgrade","type":"object","properties":{"group":{"$ref":"#/definitions/UpgradeUnitGroupInfo"},"warnings":{"items":{"type":"string"},"readOnly":true,"type":"array","description":"List of warnings indicating issues with the upgrade unit that may result in upgrade failure","title":"List of warnings indicating issues with the upgrade unit that may result in upgrade failure"},"current_version":{"readOnly":true,"type":"string","description":"This is component version e.g. if upgrade unit is of type edge, then this is edge version.","title":"Current version of upgrade unit"},"metadata":{"items":{"$ref":"#/definitions/KeyValuePair"},"readOnly":true,"type":"array","description":"Metadata about upgrade unit","title":"Metadata about upgrade unit"},"type":{"readOnly":false,"type":"string","description":"Upgrade unit type","title":"Upgrade unit type"},"id":{"readOnly":true,"type":"string","description":"Identifier of the upgrade unit","title":"UUID of the upgrade unit"},"display_name":{"readOnly":false,"type":"string","description":"Name of the upgrade unit","title":"Name of the upgrade unit"}}}]},"ServiceCapability":{"x-vmw-nsx-module":"ServiceInsertionCommonTypes","type":"object","description":"Service capabilities that will be inherited by service VMs created using a service definition that contains this service capability.","properties":{"nsh_liveness_support_enabled":{"default":false,"readOnly":false,"type":"boolean","description":"Indicating whether service supports NSH liveness detection.","title":"NSH liveness support flag"},"can_decrement_si":{"default":false,"readOnly":true,"type":"boolean","description":"Indicating whether service is configured to decrement SI field in NSH metadata.","title":"SI decrement flag"}},"title":"Service capabilities"},"NSGroupInfo":{"x-vmw-nsx-module":"ServiceInsertionCommonTypes","type":"object","description":"NSGroupInfo contains information about a particular NSGroup used in a SI Rule. It also contains information about policy path used to create this NSGroup.","properties":{"nsgroup_policy_path":{"readOnly":true,"type":"string","description":"Relative Policy path of a particular NSGroup.","title":"Policy Path of a Particular NSGroup"},"nsgroup":{"$ref":"#/definitions/ResourceReference"}},"title":"NSGroupInfo"},"LogicalSwitchStatistics":{"x-vmw-nsx-module":"AggSvcLogicalSwitch","allOf":[{"$ref":"#/definitions/AggregatedDataCounterEx"},{"x-vmw-nsx-module":"AggSvcLogicalSwitch","type":"object","properties":{"last_update_timestamp":{"description":"Timestamp when the data was last updated; unset if data source has never updated the data.","format":"int64","readOnly":true,"type":"integer"},"logical_switch_id":{"readOnly":true,"type":"string","description":"The id of the logical Switch","title":"The id of the logical Switch"}}}]},"IPSecVPNIKETrafficStatistics":{"x-vmw-nsx-module":"VPNStatistics","type":"object","description":"Traffic statistics for IPSec VPN IKE session. Note - Not supported in this release.","properties":{"packets_out":{"readOnly":true,"format":"int64","type":"integer","description":"Number of packets out.","title":"Packets out"},"fail_count":{"readOnly":true,"format":"int64","type":"integer","description":"Fail count.","title":"Fail count"},"packets_in":{"readOnly":true,"format":"int64","type":"integer","description":"Number of packets in.","title":"Packets in"},"bytes_out":{"readOnly":true,"format":"int64","type":"integer","description":"Number of bytes out.","title":"Bytes out"},"bytes_in":{"readOnly":true,"format":"int64","type":"integer","description":"Number of bytes in.","title":"Bytes in"}},"title":"IPSec VPN IKE traffic statistics"},"SwitchingProfileTypeIdEntry":{"x-vmw-nsx-module":"BaseSwitchingProfile","required":["value"],"type":"object","properties":{"value":{"readOnly":false,"type":"string","description":"key value"},"key":{"description":"Supported switching profiles.\n'PortMirroringSwitchingProfile' is deprecated, please turn to\n\"Troubleshooting And Monitoring: Portmirroring\" and use\nPortMirroringSession API for port mirror function.\n","enum":["QosSwitchingProfile","PortMirroringSwitchingProfile","IpDiscoverySwitchingProfile","SpoofGuardSwitchingProfile","SwitchSecuritySwitchingProfile","MacManagementSwitchingProfile"],"type":"string"}}},"LiveTraceFilterInvalidInfo":{"x-vmw-nsx-module":"LiveTrace","type":"object","properties":{"filter":{"$ref":"#/definitions/LiveTraceFilterData"},"reason":{"readOnly":true,"type":"string","description":"The description of why the filter is rejected by the transport node.","title":"Reason of invalid packet filter"}}},"LbUdpMonitor":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/LbActiveMonitor"},{"x-vmw-nsx-module":"LoadBalancer","required":["receive","send"],"type":"object","properties":{"receive":{"type":"string","description":"Expected data, can be anywhere in the response and it has to be a\nstring, regular expressions are not supported.\nUDP healthcheck is considered failed if there is no server response\nwithin the timeout period.\n","title":"expected data received from server"},"send":{"type":"string","description":"The data to be sent to the monitored server.\n","title":"data to send"}}}]},"L2ForwarderStatistics":{"x-vmw-nsx-module":"AggSvcL2Forwarder","type":"object","properties":{"last_update_timestamp":{"description":"Timestamp when the l2 forwarder statistics was last updated.\n","format":"int64","readOnly":true,"type":"integer"},"logical_switch_id":{"readOnly":true,"type":"string","description":"Logical switch id on which the L2 forwarder is created.\n","title":"Logical switch id of L2 forwarder"},"rx":{"$ref":"#/definitions/InterSitePortCounters"},"tx":{"$ref":"#/definitions/InterSitePortCounters"}}},"BgpNeighborRouteDetailsInCsvFormat":{"x-vmw-nsx-module":"AggSvcLogicalRouter","allOf":[{"$ref":"#/definitions/CsvListResult"},{"x-vmw-nsx-module":"AggSvcLogicalRouter","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/BgpNeighborRouteDetailsCsvRecord"},"type":"array"}}}]},"MonthlyTelemetrySchedule":{"x-vmw-nsx-module":"TelemetryConfig","allOf":[{"$ref":"#/definitions/TelemetrySchedule"},{"x-vmw-nsx-module":"TelemetryConfig","required":["day_of_month","hour_of_day"],"type":"object","properties":{"minutes":{"description":"Minute at which data will be collected. Specify a value between 0 through 59.\n","title":"Minute at which data will be collected","default":0,"format":"int64","maximum":59,"minimum":0,"type":"integer"},"day_of_month":{"description":"Day of month on which data will be collected. Specify a value between 1 through 31.\n","format":"int64","title":"Day of month on which data will be collected","maximum":31,"minimum":1,"type":"integer"},"hour_of_day":{"description":"Hour at which data will be collected. Specify a value between 0 through 23.\n","format":"int64","title":"Hour at which data will be collected","maximum":23,"minimum":0,"type":"integer"}}}]},"NodeUserSettings":{"x-vmw-nsx-module":"FabricNode","type":"object","properties":{"cli_username":{"default":"admin","type":"string","description":"To configure username, you must provide this property together with\ncli_password. Username must contain ASCII characters only.\n","title":"CLI \"admin\" username"},"audit_username":{"type":"string","description":"The default username is \"audit\". To configure username, you must provide\nthis property together with audit_password. Username must contain\nASCII characters only.\n","title":"CLI \"audit\" username"},"root_password":{"type":"string","description":"Password for the node root user. For deployment,\nthis property is required. After deployment, this property is ignored, and\nthe node cli must be used to change the password.\nThe password specified must be at least 12 characters in length and must\ncontain at least one lowercase, one uppercase, one numeric character and\n one special character (except quotes). Passwords based on dictionary words\nand palindromes are invalid.\n","title":"Node root user password"},"cli_password":{"type":"string","description":"Password for the node cli user. For deployment,\nthis property is required. After deployment, this property is ignored, and\nthe node cli must be used to change the password.\nThe password specified must be at least 12 characters in length and must\ncontain at least one lowercase, one uppercase, one numeric character and\none special character (except quotes). Passwords based on dictionary words\nand palindromes are invalid.\n","title":"Node cli password"},"audit_password":{"type":"string","description":"Password for the node audit user. For deployment,\nthis property is required. After deployment, this property is ignored, and\nthe node cli must be used to change the password.\nThe password specified must be at least 12 characters in length and must\ncontain at least one lowercase, one uppercase, one numeric character and\none special character (except quotes). Passwords based on dictionary words\nand palindromes are invalid.\n","title":"Node audit user password"}}},"PreconfiguredHostSwitch":{"description":"Preconfigured host switch is used for manually configured transport node.","title":"Preconfigured host switch","required":["host_switch_id"],"x-vmw-nsx-module":"TransportNode","type":"object","properties":{"host_switch_id":{"readOnly":false,"type":"string","description":"External Id of the preconfigured host switch.","title":"External Id of the preconfigured host switch."},"endpoints":{"items":{"$ref":"#/definitions/PreconfiguredEndpoint"},"type":"array","description":"List of virtual tunnel endpoints which are preconfigured on this host switch","maxItems":1,"title":"List of virtual tunnel endpoints which are preconfigured on this host switch"},"transport_zone_endpoints":{"items":{"$ref":"#/definitions/TransportZoneEndPoint"},"readOnly":false,"type":"array","description":"List of TransportZones that are to be associated with specified host switch.","title":"Transport zone endpoints."}}},"ClasslessStaticRoute":{"description":"DHCP classless static route option.","title":"DHCP classless static route option","required":["next_hop","network"],"x-vmw-nsx-module":"Dhcp","type":"object","properties":{"next_hop":{"description":"IP address of next hop of the route.","format":"ip","type":"string"},"network":{"description":"Destination network in CIDR format.","format":"address-or-block-or-range","type":"string"}}},"MigratedObjectListResult":{"x-vmw-nsx-module":"PolicyMigration","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"PolicyMigration","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/MigratedObject"},"type":"array","description":"Migrated resource list results.\n","title":"Migrated resource list results."}}}]},"AviEndPoint":{"description":"Details about the AVI LB endpoint","title":"AVI LB endpoint details","required":["avi_endpoint_username","avi_endpoint_ip"],"x-vmw-nsx-module":"Migration","type":"object","properties":{"avi_endpoint_username":{"readOnly":false,"type":"string","description":"Username for AVI LB endpoint.","title":"Username for AVI LB endpoint"},"avi_endpoint_port":{"description":"AVI LB endpoint port.","format":"int32","default":443,"title":"AVI LB endpoint port","readOnly":false,"type":"integer"},"avi_endpoint_ip":{"readOnly":false,"format":"hostname-or-ip","type":"string","description":"IP address of the AVI LB endpoint.","title":"IP address of the AVI LB endpoint"},"avi_endpoint_password":{"readOnly":false,"type":"string","description":"Password for AVI LB endpoint.","title":"Password for AVI LB endpoint"}}},"HealthCheckSpecVlans":{"description":"HealthCheckSpecVlan is used for specifying VLAN ID ranges for healthcheck.\n","title":"VLAN Range Specification","required":["vlan_ranges"],"x-vmw-nsx-module":"HealthCheck","type":"object","properties":{"vlan_ranges":{"minItems":1,"items":{"$ref":"#/definitions/HealthCheckVlanRange"},"type":"array","description":"VLAN ID ranges","title":"VLAN ID ranges"}}},"CsrWithDaysValid":{"x-vmw-nsx-module":"CertificateManager","allOf":[{"$ref":"#/definitions/Csr"},{"x-vmw-nsx-module":"CertificateManager","type":"object","properties":{"days_valid":{"description":"Number of days the certificate will be valid, default 825 days","title":"Number of days the certificate will be valid, default 825 days","default":825,"format":"int64","maximum":10000,"minimum":1,"type":"integer"}}}],"description":"CSR data with days valid","title":"CSR data with days valid"},"VsphereClusterNodeVMDeploymentConfig":{"x-vmw-nsx-module":"ClusterNodeVMDeployment","allOf":[{"$ref":"#/definitions/ClusterNodeVMDeploymentConfig"},{"required":["storage_id","management_network_id","hostname","vc_id","compute_id"],"x-vmw-nsx-module":"ClusterNodeVMDeployment","type":"object","properties":{"dns_servers":{"minItems":1,"items":{"description":"IPv4 address","format":"ipv4","type":"string"},"type":"array","description":"List of DNS servers.\nIf DHCP is used, the default DNS servers associated with\nthe DHCP server will be used instead.\nRequired if using static IP.\n","title":"DNS servers"},"search_domains":{"items":{"type":"string"},"type":"array","description":"List of domain names that are used to complete unqualified host names.\n","title":"DNS search domain names"},"management_network_id":{"type":"string","description":"Distributed portgroup identifier to which the management vnic of\ncluster node VM will be connected.\n","title":"Portgroup identifier for management network connectivity"},"enable_ssh":{"default":false,"type":"boolean","description":"If true, the SSH service will automatically be started on the VM.\nEnabling SSH service is not recommended for security reasons.\n","title":"Enable SSH"},"allow_ssh_root_login":{"default":false,"type":"boolean","description":"If true, the root user will be allowed to log into the VM.\nAllowing root SSH logins is not recommended for security reasons.\n","title":"Allow root SSH logins"},"compute_id":{"type":"string","description":"The cluster node VM will be deployed on the specified cluster or\nresourcepool for specified VC server.\n","title":"Cluster identifier or resourcepool identifier"},"ntp_servers":{"items":{"description":"Hostname or IPv4 address","format":"hostname-or-ipv4","type":"string"},"type":"array","description":"List of NTP servers.\nTo use hostnames, a DNS server must be defined. If not using DHCP,\na DNS server should be specified under dns_servers.\n","title":"NTP servers"},"disk_provisioning":{"description":"Specifies the disk provisioning type of the VM.\n","default":"THIN","enum":["THIN","LAZY_ZEROED_THICK","EAGER_ZEROED_THICK"],"type":"string"},"folder_id":{"type":"string","description":"Specifies the folder in which the VM should be placed.\n","title":"Folder identifier"},"vc_id":{"type":"string","description":"The VC-specific identifiers will be resolved on this VC, so all other\nidentifiers specified in the config must belong to this vCenter server.\n","title":"Vsphere compute identifier for identifying VC server"},"storage_id":{"type":"string","description":"The cluster node VM will be deployed on the specified datastore in\nthe specified VC server. User must ensure that storage is accessible\nby the specified cluster/host.\n","title":"Storage/datastore identifier"},"default_gateway_addresses":{"description":"The default gateway for the VM to be deployed must be specified if all\nthe other VMs it communicates with are not in the same subnet.\nDo not specify this field and management_port_subnets to use DHCP.\nNote: only single IPv4 default gateway address is supported and it\nmust belong to management network.\nIMPORTANT: VMs deployed using DHCP are currently not supported,\nso this parameter should be specified.\n","title":"Default gateway for the VM","minItems":1,"items":{"description":"IPv4 or IPv6 address","format":"ip","type":"string"},"maxItems":1,"type":"array"},"management_port_subnets":{"description":"IP Address and subnet configuration for the management port.\nDo not specify this field and default_gateway_addresses to use DHCP.\nNote: only one IPv4 address is supported for the management port.\nIMPORTANT: VMs deployed using DHCP are currently not supported,\nso this parameter should be specified.\n","title":"Port subnets for management port","minItems":1,"items":{"$ref":"#/definitions/IPSubnet"},"maxItems":1,"type":"array"},"host_id":{"type":"string","description":"The cluster node VM will be deployed on the specified host in the\nspecified VC server within the cluster if host_id is specified.\nNote: User must ensure that storage and specified networks are\naccessible by this host.\n","title":"Host identifier"},"hostname":{"type":"string","description":"Desired host name/FQDN for the VM to be deployed","title":"Host name or FQDN for the VM"}}}],"description":"The Vsphere deployment configuration determines where to deploy the\ncluster node VM through a vCenter server. It contains settings that are\napplied during install time.\nIf using DHCP, the following fields must be left unset - dns_servers,\nmanagement_port_subnets, and default_gateway_addresses\n","title":"Deployment config on the Vsphere platform"},"NodeInterfaceProperties":{"x-vmw-nsx-module":"ApplianceStats","type":"object","description":"Node network interface properties","properties":{"host_managed":{"type":"boolean","description":"Indicates whether interface is managed by the host","title":"Indicates whether interface is managed by the host"},"interface_uuid":{"readOnly":true,"type":"string","description":"UUID of the interface","title":"UUID of the interface"},"connected_switch_type":{"readOnly":true,"enum":["VSS","DVS","N-VDS"],"type":"string","description":"Type of switch associated with the interface.","title":"Type of switch"},"link_status":{"enum":["UP","DOWN"],"type":"string","description":"Interface administration status","title":"Interface administration status"},"ens_enabled":{"type":"boolean","description":"Indicates whether interface is enabled for Enhanced Networking Stack","title":"Indicates whether interface is enabled for Enhanced Networking Stack"},"interface_type":{"enum":["PHYSICAL","VIRTUAL","BOND","TEAMING"],"type":"string","description":"Interface Type","title":"Interface Type"},"connected_switch":{"type":"string","description":"Connected switch","title":"Connected switch"},"interface_id":{"type":"string","description":"Interface ID","title":"Interface ID"},"source":{"description":"Source of status data","enum":["realtime","cached"],"type":"string"},"admin_status":{"enum":["UP","DOWN"],"type":"string","description":"Interface administration status","title":"Interface administration status"},"pci":{"readOnly":true,"type":"string","description":"PCI device.","title":"PCI device"},"backing_nsx_managed":{"type":"boolean","description":"Indicates whether backing of VIRTUAL network interface is managed by NSX","title":"Indicates whether backing of VIRTUAL network interface is managed by NSX"},"key":{"readOnly":true,"type":"string","description":"Device key.","title":"Device key"},"interface_alias":{"items":{"$ref":"#/definitions/NodeInterfaceAlias"},"type":"array","description":"IP Alias","title":"IP Alias"},"device":{"readOnly":true,"type":"string","description":"Device name.","title":"Device name"},"lport_attachment_id":{"type":"string","description":"LPort Attachment Id assigned to VIRTUAL network interface of a node","title":"LPort Attachment Id assigned to VIRTUAL network interface of a node"},"mtu":{"format":"int64","type":"integer","description":"Interface MTU","title":"Interface MTU"},"driver":{"readOnly":true,"type":"string","description":"Driver name.","title":"Driver name"},"ens_interrupt_capable":{"type":"boolean","description":"This boolean property describes if network interface is capable for Enhanced Networking Stack interrupt","title":"Interface capability for Enhanced Networking Stack interrupt"},"ens_capable":{"type":"boolean","description":"Interface capability for Enhanced Networking Stack","title":"Interface capability for Enhanced Networking Stack"},"ens_interrupt_enabled":{"type":"boolean","description":"This boolean property describes if network interface is enabled for Enhanced Networking Stack interrupt","title":"Indicates whether interface is enabled for Enhanced Networking Stack interrupt"}},"title":"Node network interface properties"},"PluginFileProperties":{"x-vmw-nsx-module":"SystemHealthPlugin","allOf":[{"$ref":"#/definitions/Resource"},{"required":["status","file_name","plugin_id"],"x-vmw-nsx-module":"SystemHealthPlugin","type":"object","properties":{"status":{"type":"string","description":"Upload status","title":"Upload status"},"file_name":{"type":"string","description":"File name","title":"File name"},"plugin_id":{"type":"string","description":"Plugin id","title":"Plugin id"}}}],"description":"Plugin file properties","title":"Plugin file properties"},"FileTransferProtocol":{"description":"Protocol to transfer backup file to remote server","title":"Protocol to transfer backup file to remote server","required":["protocol_name","ssh_fingerprint","authentication_scheme"],"x-vmw-nsx-module":"BackupConfiguration","type":"object","properties":{"protocol_name":{"default":"sftp","enum":["sftp"],"type":"string","description":"Protocol name","title":"Protocol name"},"ssh_fingerprint":{"type":"string","description":"The expected SSH fingerprint of the server. If the server's fingerprint\ndoes not match this fingerprint, the connection will be terminated.\n\nOnly ECDSA fingerprints hashed with SHA256 are supported. To obtain the\nhost's ssh fingerprint, you should connect via some method other than\nSSH to obtain this information. You can use one of these commands to\nview the key's fingerprint:\n1. ssh-keygen -l -E sha256 -f ssh_host_ecdsa_key.pub\n2. awk '{print $2}' ssh_host_ecdsa_key.pub | base64 -d | sha256sum -b |\n sed 's/ .*$//' | xxd -r -p | base64 | sed 's/.//44g' |\n awk '{print \"SHA256:\"$1}'\n","title":"SSH fingerprint of server"},"authentication_scheme":{"$ref":"#/definitions/FileTransferAuthenticationScheme"}}},"NSService":{"x-vmw-nsx-module":"NSService","description":"A Networking and Security Service allows users to specify characteristics to use\nfor matching network traffic. For example the user can specify port and protocol\npair.\n","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"NSService","required":["nsservice_element"],"type":"object","properties":{"default_service":{"readOnly":true,"type":"boolean","description":"The default NSServices are created in the system by default. These NSServices\ncan't be modified/deleted\n","title":"NSServices created in the system by default"},"nsservice_element":{"$ref":"#/definitions/NSServiceElement"}}}]},"Legend":{"x-vmw-nsx-module":"NsxDashboard","type":"object","description":"Represents legend that describes the entities of the widget.","properties":{"display_mode":{"default":"SHOW_ALL_LEGENDS","enum":["SHOW_ALL_LEGENDS","SHOW_MIN_NO_OF_LEGENDS","SHOW_OTHER_GROUP_WITH_LEGENDS"],"type":"string","description":"Display mode for legends.","title":"Display mode for legends."},"alignment":{"default":"VERTICAL","enum":["HORIZONTAL","VERTICAL"],"type":"string","description":"Describes the alignment of legend. Alignment of a legend denotes how individual items of the legend are aligned in a container. For example, if VERTICAL is chosen then the items of the legend will appear one below the other and if HORIZONTAL is chosen then the items will appear side by side.","title":"Alignment of the legend"},"filterable":{"default":false,"type":"boolean","description":"Show checkbox along with legends if value is set to true. Widget filtering capability can be enable based on legend checkbox selection. for 'display_mode' SHOW_OTHER_GROUP_WITH_LEGENDS filterable property is not supported.","title":"Show checkbox along with legends if value is set to true"},"position":{"default":"RIGHT","enum":["TOP","BOTTOM","LEFT","RIGHT","TOP_RIGHT"],"type":"string","description":"Describes the relative placement of legend. The legend of a widget can be placed either to the TOP or BOTTOM or LEFT or RIGHT relative to the widget. For example, if RIGHT is chosen then legend is placed to the right of the widget.","title":"Placement of legend"},"display_count":{"default":true,"type":"boolean","description":"If set to true, it will display the counts in legend. If set to false, counts of entities are not displayed in the legend.","title":"Show count of entities in the legend"},"type":{"default":"CIRCLE","enum":["CIRCLE"],"type":"string","description":"Describes the render type for the legend. The legend for an entity describes the entity in the widget. The supported legend type is a circle against which the entity's details such as display_name are shown. The color of the circle denotes the color of the entity shown inside the widget.","title":"Type of the legend"},"min_legends_display_count":{"description":"A minimum number of legends to be displayed upfront. if 'display_mode' is set to SHOW_MIN_NO_OF_LEGENDS then this property value will be used to display number of legends upfront in the UI.","title":"A minimum number of legends to be displayed.","default":3,"format":"int32","maximum":12,"minimum":1,"type":"integer"},"unit":{"type":"string","description":"Show unit of entities in the legend.","title":"Show unit of entities in the legend"},"other_group_legend_label":{"default":"WIDGET_LABEL_OTHER_LEGEND_LABEL","type":"string","description":"A translated label for showing other category label in legends.","title":"A label for showing other category in legends."}},"title":"Legend for the widget"},"ProgressItemPart":{"x-vmw-nsx-module":"SiteManagerModule","required":["status","percentage","description","name"],"type":"object","properties":{"status":{"enum":["RUNNING","ERROR","COMPLETE"],"type":"string","description":"Status of this process","title":"Status of this process"},"percentage":{"format":"int64","type":"integer","description":"0 - 100 of the task being completed","title":"0 - 100 of the task being completed"},"error":{"type":"string","description":"Error message, if ran into error","title":"Error message, if ran into error"},"description":{"type":"string","description":"Description of the process","title":"Description of the process"},"name":{"type":"string","description":"Name of the process","title":"Name of the process"}}},"BackupUiFramesInfo":{"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"api_endpoint":{"readOnly":true,"enum":["global-manager","nsxapi","ica"],"type":"string","description":"prefix to be used for api call","title":"prefix to be used for api call"},"frame_type":{"readOnly":true,"enum":["GLOBAL_MANAGER","LOCAL_MANAGER","LOCAL_LOCAL_MANAGER","NSX_INTELLIGENCE"],"type":"string","description":"Type of service, for which backup is handled","title":"Type of service, for which backup is handled"},"active_gm":{"readOnly":true,"enum":["ACTIVE","STANDBY","NONE","INVALID"],"type":"string","description":"Does site have active GM","title":"Does site have active GM"},"site_version":{"readOnly":true,"type":"string","description":"Version of the site","title":"Version of the site"},"site_id":{"readOnly":true,"type":"string","description":"Id of the site","title":"Id of the site"}}},"FirewallDnsProfile":{"x-vmw-nsx-module":"FirewallProfile","allOf":[{"$ref":"#/definitions/BaseFirewallProfile"},{"x-vmw-nsx-module":"FirewallProfile","type":"object","properties":{"dns_ttl_config":{"$ref":"#/definitions/DnsTtlConfig"}}}],"description":"A profile holding DNS configuration which allows firewall to use DNS response packets and manage firewall cache. e.g. TTL used to expire snooped entries from cache.","title":"Firewall DNS profile"},"IpfixUpmProfileListResult":{"x-vmw-nsx-module":"UpmIpfix","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"UpmIpfix","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/IpfixUpmProfile"},"readOnly":true,"type":"array","description":"IPFIX Profile List","title":"IPFIX Profile List"}}}],"description":"IPFIX profile list result for query with list parameters","title":"List of IPFIX Profiles"},"ContainerProject":{"x-vmw-nsx-module":"InventoryContainerObj","allOf":[{"$ref":"#/definitions/DiscoveredResource"},{"required":["external_id"],"x-vmw-nsx-module":"InventoryContainerObj","type":"object","properties":{"network_status":{"readOnly":false,"enum":["HEALTHY","UNHEALTHY"],"type":"string","description":"Network status of container project.","title":"Network status of container project"},"container_cluster_id":{"readOnly":false,"type":"string","description":"Identifier of the container cluster to which this project/namespace belongs.","title":"Identifier of the container cluster"},"origin_properties":{"items":{"$ref":"#/definitions/KeyValuePair"},"readOnly":false,"type":"array","description":"Array of additional specific properties of container project\nin key-value format.\n","title":"Origin properties"},"external_id":{"readOnly":false,"type":"string","description":"External identifier of the container project.","title":"External identifier of the container project"},"network_errors":{"items":{"$ref":"#/definitions/NetworkError"},"readOnly":false,"type":"array","description":"List of network errors related to container project.","title":"Network errors"}}}],"description":"Details of org/namespace within a container cluster.","title":"Container project within a container cluster"},"PolicyPktCapResource":{"x-vmw-nsx-module":"PolicyConnectivity","allOf":[{"$ref":"#/definitions/PktCapResource"},{"x-vmw-nsx-module":"PolicyConnectivity","type":"object","properties":{"logical_port_path":{"readOnly":true,"type":"string","description":"The path of segment port or router port where the packets are captured","title":"The path of segment port or router port where the packets are captured"}}}]},"IpfixDfwTemplateParameters":{"x-vmw-nsx-module":"Ipfix","type":"object","description":"This entity represents the flow parameters which are exported.\n","properties":{"source_icmp_type":{"default":true,"readOnly":true,"type":"boolean","description":"Type of the IPv4 ICMP message.\n"},"icmp_code":{"default":true,"readOnly":true,"type":"boolean","description":"Code of the IPv4 ICMP message.\n"},"destination_transport_port":{"default":true,"readOnly":true,"type":"boolean","description":"The destination transport port of a monitored network flow.\n"},"octet_delta_count":{"default":true,"readOnly":true,"type":"boolean","description":"The number of octets since the previous report (if any) in incoming\npackets for this flow at the observation point. The number of octets\ninclude IP header(s) and payload.\n"},"vif_uuid":{"default":true,"readOnly":true,"type":"boolean","description":"VIF UUID - enterprise specific Information Element that uniquely identifies VIF.\n"},"protocol_identifier":{"default":true,"readOnly":true,"type":"boolean","description":"The value of the protocol number in the IP packet header.\n"},"firewall_event":{"default":true,"readOnly":true,"type":"boolean","description":"Five valid values are allowed: 1. Flow Created. 2. Flow Deleted.\n3. Flow Denied. 4. Flow Alert (not used in DropKick implementation).\n5. Flow Update.\n"},"flow_direction":{"default":true,"readOnly":true,"type":"boolean","description":"Two valid values are allowed: 1. 0x00: igress flow to VM. 2. 0x01:\negress flow from VM.\n"},"flow_end":{"default":true,"readOnly":true,"type":"boolean","description":"The absolute timestamp (seconds) of the last packet of this flow.\n"},"source_transport_port":{"default":true,"readOnly":true,"type":"boolean","description":"The source transport port of a monitored network flow.\n"},"packet_delta_count":{"default":true,"readOnly":true,"type":"boolean","description":"The number of incoming packets since the previous report (if any)\nfor this flow at the observation point.\n"},"destination_address":{"default":true,"readOnly":true,"type":"boolean","description":"The destination IP address of a monitored network flow.\n"},"source_address":{"default":true,"readOnly":true,"type":"boolean","description":"The source IP address of a monitored network flow.\n"},"rule_id":{"default":true,"readOnly":true,"type":"boolean","description":"Firewall rule Id - enterprise specific Information Element that uniquely identifies\nfirewall rule.\n"},"flow_start":{"default":true,"readOnly":true,"type":"boolean","description":"The absolute timestamp (seconds) of the first packet of this flow.\n"}},"title":"IPFIX DFW Template Parameters"},"EffectiveProfileListResult":{"x-vmw-nsx-module":"ServiceConfig","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"ServiceConfig","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/NSXProfileReference"},"type":"array","description":"Paged Collection of profiles which are applied to an Entity","title":"Paged Collection of profiles which are applied to an Entity"}}}]},"LbVariablePersistenceLearnAction":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/LbRuleAction"},{"required":["variable_name"],"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"variable_hash_enabled":{"default":false,"type":"boolean","description":"The property is used to enable a hash operation for variable value\nwhen composing the persistence key.\n","title":"Whether to enable a hash operation for variable value"},"variable_name":{"type":"string","description":"The property is the name of variable to be learnt. It is used to\nidentify which variable's value is learnt from HTTP response.\nThe variable can be a system embedded variable such as\n\"_cookie_JSESSIONID\", a customized variable defined in\nLbVariableAssignmentAction or a captured variable in regular expression\nsuch as \"article\".\n","title":"Variable name"},"persistence_profile_id":{"type":"string","description":"If the persistence profile UUID is not specified, a default\npersistence table is created per virtual server. Currently, only\nLbGenericPersistenceProfile is supported.\n","title":"UUID of LbPersistenceProfile"}}}],"description":"This action is performed in HTTP response rewrite phase. It is used to\nlearn the value of variable from the HTTP response, and insert an entry\ninto the persistence table if the entry doesn't exist.\n","title":"Action to learn the variable value"},"AuditLogListResult":{"x-vmw-nsx-module":"MISSING_MODULE","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["last_full_sync_timestamp","results"],"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"last_full_sync_timestamp":{"type":"string","description":"Timestamp of the last full audit log collection","title":"Timestamp of the last full audit log collection"},"results":{"items":{"$ref":"#/definitions/AuditLog"},"type":"array","description":"Audit log results","title":"Audit log results"}}}],"description":"Audit log collection results","title":"Audit log collection results"},"ClusterNodeConfig":{"x-vmw-nsx-module":"ClusterManagement","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"ClusterManagement","type":"object","properties":{"manager_role":{"$ref":"#/definitions/ManagementClusterRoleConfig"},"controller_role":{"$ref":"#/definitions/ControllerClusterRoleConfig"},"external_id":{"readOnly":true,"type":"string","description":"Internal identifier provided by the node","title":"Internal identifier provided by the node"},"appliance_mgmt_listen_addr":{"readOnly":true,"type":"string","description":"The IP and port for the appliance management API service on this node","title":"The IP and port for the appliance management API service on this node"}}}]},"ServiceAttachment":{"x-vmw-nsx-module":"ServiceInsertionCommonTypes","allOf":[{"$ref":"#/definitions/ManagedResource"},{"required":["deployed_to"],"x-vmw-nsx-module":"ServiceInsertionCommonTypes","type":"object","properties":{"logical_routers":{"description":"List of LogicalRouters to be connected to the ServicePlane logical switch via a ServiceLink.","title":"Logical Router list","minItems":1,"items":{"$ref":"#/definitions/ResourceReference"},"readOnly":false,"maxItems":128,"type":"array"},"logical_switch":{"$ref":"#/definitions/ResourceReference"},"local_ips":{"description":"Local IPs associated with this Service Attachment.","title":"Local IPs","minItems":1,"items":{"$ref":"#/definitions/IPInfo"},"maxItems":1,"type":"array"},"service_port":{"$ref":"#/definitions/ResourceReference"},"deployed_to":{"$ref":"#/definitions/ResourceReference"},"attachment_status":{"description":"UP - A Service Attachment will have its Service Port - UP and with a configured IP address. DOWN - An Inactive ServiceAttachment has its Service Port - DOWN. It can be used to connect set of appliances that do not need to exchange traffic to/from/through the Edge node.","title":"Attachment Status","default":"UP","enum":["UP","DOWN"],"readOnly":false,"type":"string"}}}],"description":"A ServiceAttachment represents a point on NSX entity (Example - Edge Router) to which ServiceInstance can be connected through an InstanceEndpoint. Example - In VMWare Hybric Cloud Extention (HCX) use case, HCX appliances connect to this Service Attachment Point. We do not handle the lifecycle of these appliance/s.","title":"Logical Attachment Point for a 3rd Party Service"},"SIAggregatedDataCounter":{"x-vmw-nsx-module":"ServiceInsertionVMDeployment","type":"object","properties":{"tx_bytes":{"$ref":"#/definitions/SIDataCounter"},"rx_packets":{"$ref":"#/definitions/SIDataCounter"},"tx_packets":{"$ref":"#/definitions/SIDataCounter"},"rx_bytes":{"$ref":"#/definitions/SIDataCounter"}}},"AntreaContainerClusterNode":{"description":"Antrea container cluster and its nodes requiring a support bundle","title":"Antrea container cluster and its nodes requiring a support bundle","required":["cluster_id"],"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"nodes":{"minItems":1,"items":{"type":"string"},"type":"array","description":"List of at most 200 container node UUIDs requiring a support bundle","title":"List of at most 200 container node UUIDs requiring a support bundle"},"cluster_id":{"type":"string","description":"The UUID of the container cluster","title":"The UUID of the container cluster"}}},"ManualHealthCheckListResult":{"x-vmw-nsx-module":"HealthCheck","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"HealthCheck","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/ManualHealthCheck"},"readOnly":true,"type":"array","description":"Manual Health Check List","title":"Manual Health Check List"}}}],"description":"Manual health check list result for query with list parameters.","title":"List of Manual Health Checks"},"MigrationUnitGroup":{"x-vmw-nsx-module":"Migration","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"Migration","required":["type"],"type":"object","properties":{"migration_unit_count":{"readOnly":true,"format":"int32","type":"integer","description":"Number of migration units in the group","title":"Count of migration units in the group"},"migration_units":{"description":"List of migration units in the group","title":"List of migration units in the group","items":{"$ref":"#/definitions/MigrationUnit"},"readOnly":false,"maxItems":100,"type":"array"},"enabled":{"default":true,"readOnly":false,"type":"boolean","description":"Flag to indicate whether migration of this group is enabled or not","title":"Flag to indicate whether migration of this group is enabled or not"},"type":{"readOnly":false,"type":"string","description":"Component type","title":"Component type"},"parallel":{"default":true,"readOnly":false,"type":"boolean","description":"Migration method to specify whether the migration is to be performed in parallel or serially","title":"Migration method to specify whether the migration is to be performed in parallel or serially"},"extended_configuration":{"description":"Extended configuration for the group","title":"Extended configuration for the group","items":{"$ref":"#/definitions/KeyValuePair"},"readOnly":false,"maxItems":100,"type":"array"}}}]},"CommunityMatchOperation":{"x-vmw-nsx-module":"Routing","type":"object","description":"Community match operation","properties":{"match_operator":{"default":"MATCH_ANY","enum":["MATCH_ANY","MATCH_ALL","MATCH_EXACT","MATCH_NONE","MATCH_REGEX","MATCH_LARGE_COMMUNITY_REGEX"],"type":"string","description":"Match operator for communities from provided community list id.\nMATCH_ANY will match any community\nMATCH_ALL will match all communities\nMATCH_EXACT will do exact match on community\nMATCH_NONE [operator not supported] will not match any community\nMATCH_REGEX will match normal communities by evaluating regular\nexpression\nMATCH_LARGE_COMMUNITY_REGEX will match large communities by evaluating\nregular expression\n","title":"Match operator"},"regular_expression":{"type":"string","description":"Regular expression to match BGP communities. If match_operator\nis MATCH_REGEX then this value must be specified.\n","title":"Regular expression"},"community_list_id":{"type":"string","description":"ID of BGP community list. This value is not required when\nmatch_operator is MATCH_REGEX otherwise required.\n","title":"Community list id"}},"title":"Community match operation"},"PortMirroringSession":{"x-vmw-nsx-module":"PortMirroring","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"PortMirroring","required":["direction","mirror_sources","mirror_destination"],"type":"object","properties":{"direction":{"description":"Port mirroring session direction","enum":["INGRESS","EGRESS","BIDIRECTIONAL"],"type":"string"},"mirror_sources":{"minItems":1,"items":{"$ref":"#/definitions/MirrorSource"},"type":"array","description":"Mirror sources","title":"Mirror sources"},"encapsulation_vlan_id":{"type":"integer","description":"Only for Remote SPAN Port Mirror.","format":"int64"},"session_type":{"description":"If this property is unset, this session will be treated as\nLocalPortMirrorSession.\n","default":"LocalPortMirrorSession","enum":["LogicalPortMirrorSession","UplinkPortMirrorSession","RspanSrcMirrorSession","RspanDstMirrorSession","LocalPortMirrorSession","LogicalLocalPortMirrorSession","L3PortMirrorSession"],"type":"string"},"snap_length":{"description":"If this property is set, the packet will be truncated to the provided\nlength. If this property is unset, entire packet will be mirrored.\n","format":"int64","title":"Maximum packet length for packet truncation","maximum":65535,"minimum":60,"type":"integer"},"port_mirroring_filters":{"items":{"$ref":"#/definitions/PortMirroringFilter"},"type":"array","description":"An array of 5-tuples used to filter packets for the mirror session, if not provided, all the packets will be mirrored.","title":"Port mirror filter for this session"},"tcp_ip_stack":{"enum":["Default","Mirror"],"type":"string","description":"If set to mirror, mirror packet will be sent via dedicated mirror stack\nto destination; If set to default, mirror packet will be sent via default stack;\nSo far, the value mirror can only be chosen in L3PortMirrorSession.\n","title":"TCP/IP Stack"},"preserve_original_vlan":{"default":false,"type":"boolean","description":"Only for Remote SPAN Port Mirror. Whether to preserve original VLAN.","title":"Only for Remote SPAN Port Mirror. Whether to preserve original VLAN."},"mirror_destination":{"$ref":"#/definitions/MirrorDestination"}}}]},"NodeProperties":{"x-vmw-nsx-module":"MISSING_MODULE","allOf":[{"$ref":"#/definitions/Resource"},{"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"system_time":{"description":"Current time expressed in milliseconds since epoch","format":"int64","readOnly":true,"type":"integer"},"node_uuid":{"readOnly":true,"maxLength":36,"type":"string","description":"Node Unique Identifier","title":"Node Unique Identifier"},"motd":{"description":"Message of the day to display when users login to node using the NSX CLI","title":"Message of the day to display when users login to node using the NSX CLI"},"cli_timeout":{"format":"int64","minimum":0,"type":"integer","description":"NSX CLI inactivity timeout, set to 0 to configure no timeout","title":"NSX CLI inactivity timeout, set to 0 to configure no timeout"},"kernel_version":{"readOnly":true,"type":"string","description":"Kernel version","title":"Kernel version"},"export_type":{"readOnly":true,"enum":["RESTRICTED","UNRESTRICTED"],"type":"string","description":"Export restrictions in effect, if any","title":"Export restrictions in effect, if any"},"product_version":{"readOnly":true,"type":"string","description":"Product version","title":"Product version"},"node_version":{"readOnly":true,"type":"string","description":"Node version","title":"Node version"},"node_type":{"readOnly":true,"enum":["NSX Manager","NSX Global Manager","NSX Edge","NSX Autonomous Edge","NSX Cloud Service Manager","NSX Public Cloud Gateway"],"type":"string","description":"Node type","title":"Node type"},"system_datetime":{"type":"string","description":"System date time in UTC"},"fully_qualified_domain_name":{"readOnly":true,"type":"string","description":"Fully qualified domain name","title":"Fully qualified domain name"},"timezone":{"type":"string","description":"Timezone","title":"Timezone"},"cli_history_size":{"format":"int64","minimum":0,"type":"integer","description":"NSX CLI command history limit, set to 0 to configure no history size limit","title":"NSX CLI command history limit, set to 0 to configure no history size limit"},"hostname":{"description":"Host name or fully qualified domain name of node","pattern":"/^(?=.{1,255}$)[0-9A-Za-z](?:(?:[0-9A-Za-z]|-){0,61}[0-9A-Za-z])?(?:\\.[0-9A-Za-z](?:(?:[0-9A-Za-z]|-){0,61}[0-9A-Za-z])?)*\\.?$/","type":"string"},"cli_output_datetime":{"type":"boolean","description":"NSX CLI display datetime stamp in command output","title":"NSX CLI display datetime stamp in command output"}}}],"description":"Node properties","title":"Node properties"},"ForwarderZone":{"x-vmw-nsx-module":"DnsForwarder","required":["upstream_servers"],"type":"object","properties":{"upstream_servers":{"description":"Ip address of the upstream DNS servers the DNS forwarder accesses.\n","title":"Ips of upsteam DNS servers","minItems":1,"items":{"description":"IPv4 address","format":"ipv4","type":"string"},"maxItems":3,"type":"array"},"source_ip":{"description":"The source ip used by the fowarder of the zone. If no source ip\nspecified, the ip address of listener of the DNS forwarder will\nbe used.\n","format":"ipv4","type":"string"}}},"RoutingPolicy":{"description":"Routing policy details.","title":"Routing policy","required":["next_hop_prefix_lists_mappings"],"x-vmw-nsx-module":"LogicalRouterPorts","type":"object","properties":{"next_hop_prefix_lists_mappings":{"minItems":1,"items":{"$ref":"#/definitions/NextHopPrefixListsMapping"},"type":"array","description":"Array of next hop to prefix lists mapping.","title":"Next hop to prefix lists mappings"},"routing_policy_type":{"description":"Routing policy type.","title":"Routing policy type","default":"PROXIMITY_ROUTING","enum":["PROXIMITY_ROUTING"],"readOnly":true,"type":"string"}}},"RoleWithFeaturesListResult":{"x-vmw-nsx-module":"AAA","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"AAA","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/RoleWithFeatures"},"type":"array","description":"List results","title":"List results"}}}]},"SIMacLearningCounters":{"x-vmw-nsx-module":"ServiceInsertionVMDeployment","type":"object","properties":{"macs_learned":{"format":"int64","type":"integer","description":"Number of MACs learned","title":"Number of MACs learned"},"mac_not_learned_packets_dropped":{"format":"int64","type":"integer","description":"The number of packets with unknown source MAC address that are dropped without learning the source MAC address. Applicable only when the MAC limit is reached and MAC Limit policy is MAC_LEARNING_LIMIT_POLICY_DROP.","title":"Number of dropped packets with unknown source MAC address."},"mac_not_learned_packets_allowed":{"format":"int64","type":"integer","description":"The number of packets with unknown source MAC address that are dispatched without learning the source MAC address. Applicable only when the MAC limit is reached and MAC Limit policy is MAC_LEARNING_LIMIT_POLICY_ALLOW.","title":"Number of dispatched packets with unknown source MAC address."}}},"LbHttpRedirectAction":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/LbRuleAction"},{"required":["redirect_status","redirect_url"],"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"redirect_status":{"type":"string","description":"HTTP response status code","title":"HTTP response status code"},"redirect_url":{"type":"string","description":"The URL that the HTTP request is redirected to","title":"The URL that the HTTP request is redirected to"}}}],"description":"This action is used to redirect HTTP request messages to a new URL. The\nreply_status value specified in this action is used as the status code of\nHTTP response message which is sent back to client (Normally a browser).\nThe HTTP status code for redirection is 3xx, for example, 301, 302, 303,\n307, etc. The redirect_url is the new URL that the HTTP request message is\nredirected to. Normally browser will send another HTTP request to the new\nURL after receiving a redirection response message.\nCaptured variables and built-in variables can be used in redirect_url field.\nFor example, to redirect all HTTP requests to HTTPS requests for a virtual\nserver. We create an LbRule without any conditions, add an\nLbHttpRedirectAction to the rule. Set the\nredirect_url field of the LbHttpRedirectAction to:\n https://$_host$_request_uri\nAnd set redirect_status to \"302\", which means found. This rule will\nredirect all HTTP requests to HTTPS server port on the same host.\n","title":"Action to redirect HTTP request messages"},"AllocationPool":{"x-vmw-nsx-module":"EdgeClusters","type":"object","properties":{"standby_service_count":{"readOnly":true,"format":"int32","type":"integer","description":"Represents the number of standby services running on the edge node.\n","title":"Number of standby services on edge node"},"active_service_count":{"readOnly":true,"format":"int32","type":"integer","description":"Represents the number of acitve services running on the edge node.\n","title":"Number of active services on edge node"},"sub_pools":{"items":{"$ref":"#/definitions/SubPool"},"type":"array","description":"Allocation details of sub-pools configured on edge node.","title":"Edge node sub-pool allocation details"}}},"ComponentUpgradeStatus":{"x-vmw-nsx-module":"Upgrade","type":"object","properties":{"status":{"readOnly":true,"enum":["SUCCESS","FAILED","IN_PROGRESS","NOT_STARTED","PAUSING","PAUSED"],"type":"string","description":"Upgrade status of component","title":"Upgrade status of component"},"pre_upgrade_status":{"$ref":"#/definitions/UpgradeChecksExecutionStatus"},"details":{"readOnly":true,"type":"string","description":"Details about the upgrade status","title":"Details about the upgrade status"},"component_type":{"readOnly":true,"type":"string","description":"Component type for the upgrade status","title":"Component type for the upgrade status"},"node_count_at_target_version":{"readOnly":true,"format":"int32","type":"integer","description":"Number of nodes of the type and at the component version","title":"Count of nodes at target component version"},"target_component_version":{"readOnly":true,"type":"string","description":"Target component version","title":"Target component version"},"percent_complete":{"readOnly":true,"type":"number","description":"Indicator of upgrade progress in percentage","title":"Indicator of upgrade progress in percentage"},"can_skip":{"readOnly":true,"type":"boolean","description":"Can the upgrade of the remaining units in this component be skipped","title":"Can the upgrade of the remaining units in this component be skipped"},"can_rollback":{"readOnly":true,"type":"boolean","description":"This field indicates whether we can perform upgrade rollback.","title":"Can perform rollback"},"current_version_node_summary":{"$ref":"#/definitions/NodeSummaryList"}}},"AddClusterNodeVMInfo":{"description":"Contains a list of cluster node VM deployment requests and optionally\na clustering configuration.\n","title":"Info for AddClusterNodeVM","required":["deployment_requests"],"x-vmw-nsx-module":"ClusterNodeVMDeployment","type":"object","properties":{"deployment_requests":{"minItems":1,"items":{"$ref":"#/definitions/ClusterNodeVMDeploymentRequest"},"type":"array","description":"Cluster node VM deployment requests to be deployed by the Manager.\n","title":"List of deployment requests"},"clustering_config":{"$ref":"#/definitions/ClusteringConfig"}}},"LbNodeUsageSummary":{"x-vmw-nsx-module":"LoadBalancer","type":"object","description":"The load balancer node usage summary for all nodes. Only EdgeNode is\nsupported. The summary calculation is based on all edge nodes\nconfigured in edge clusters.\n","properties":{"node_counts":{"items":{"$ref":"#/definitions/LbNodeCountPerSeverity"},"readOnly":true,"type":"array","description":"The property identifies array of node count for each severity (RED,\nORANGE and GREEN).\n","title":"Array of node count for each severity"},"current_credit_number":{"readOnly":true,"format":"int64","type":"integer","description":"The current credit number reflects the overall credit usage for\nall nodes.\n","title":"Current credit number"},"node_usages":{"items":{"$ref":"#/definitions/LbNodeUsage"},"readOnly":true,"type":"array","description":"The property contains lb node usages for each node.\n","title":"Array of lb node usages"},"severity":{"description":"The severity calculation is based on current credit usage percentage\nof load balancer for all nodes.\n","enum":["GREEN","ORANGE","RED"],"readOnly":true,"type":"string"},"remaining_pool_members":{"readOnly":true,"format":"int64","type":"integer","description":"The overall remaining number of pool members which could be configured\non all nodes.\n","title":"The remaining number of pool members"},"current_pool_members":{"readOnly":true,"format":"int64","type":"integer","description":"The overall number of pool members configured on all nodes.\n","title":"The current number of pool members"},"usage_percentage":{"readOnly":true,"type":"number","description":"The overall usage percentage of all nodes for load balancer.\nThe value is the larger value between overall pool member usage\npercentage and overall load balancer credit usage percentage.\n","title":"Usage percentage"},"remaining_credit_number":{"readOnly":true,"format":"int64","type":"integer","description":"The remaining credit number is the overall remaining credits that can\nbe used for load balancer service configuration for all nodes.\n","title":"Remaining credit number"}},"title":"Lb node usage summary for all nodes"},"TransportNodeRemoteTunnelEndpointConfig":{"description":"Remote tunnel endpoint configuration","title":"Remote tunnel endpoint configuration","required":["host_switch_name","rtep_vlan","ip_assignment_spec"],"x-vmw-nsx-module":"TransportNode","type":"object","properties":{"named_teaming_policy":{"readOnly":false,"type":"string","description":"Specifying this field will override the default teaming policy of the host switch and will be used by remote tunnel endpoint traffic.","title":"The named teaming policy to be used by the remote tunnel endpoint"},"host_switch_name":{"readOnly":false,"type":"string","description":"The host switch name should reference an existing host switch specified in the transport node configuration. The name will be used to identify the host switch responsible for processing remote tunnel endpoint traffic.","title":"The host switch name to be used for the remote tunnel endpoint"},"rtep_vlan":{"description":"The transport VLAN id used for tagging intersite overlay traffic between remote tunnel endpoints.","format":"int64","readOnly":false,"type":"integer"},"ip_assignment_spec":{"$ref":"#/definitions/IpAssignmentSpec"}}},"BrokerProperties":{"description":"Information about a management plane node this transport node is configured to communicate with","title":"Information about a management plane node this transport node is configured to communicate with","required":["BrokerSslCertThumbprint","BrokerIpAddress"],"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"BrokerIsMaster":{"type":"string","description":"Indicates whether this broker is the master."},"BrokerIpAddress":{"description":"IP address or hostname of the message bus broker on the management plane node.","format":"hostname-or-ipv4","readOnly":false,"type":"string"},"BrokerVirtualHost":{"type":"string","description":"Type of host running the broker."},"BrokerSslCertThumbprint":{"type":"string","description":"Certificate thumbprint of the message bus broker on the management plane node."},"BrokerPort":{"type":"string","description":"Port number of the message bus broker on the management plane node."},"BrokerFqdn":{"type":"string","description":"Fully qualified domain name of the message bus broker on the management plane node."}}},"ManagementClusterRoleConfig":{"x-vmw-nsx-module":"ClusterManagement","allOf":[{"$ref":"#/definitions/ClusterRoleConfig"},{"x-vmw-nsx-module":"ClusterManagement","type":"object","properties":{"mgmt_cluster_listen_addr":{"$ref":"#/definitions/ServiceEndpoint"},"mpa_msg_client_info":{"$ref":"#/definitions/MsgClientInfo"},"api_listen_addr":{"$ref":"#/definitions/ServiceEndpoint"},"appliance_connection_info":{"$ref":"#/definitions/ServiceEndpoint"},"mgmt_plane_listen_addr":{"$ref":"#/definitions/ServiceEndpoint"}}}]},"NsxRole":{"description":"Role","title":"Role","required":["role"],"x-vmw-nsx-module":"AAA","type":"object","properties":{"role":{"type":"string","description":"This field represents the identifier of the role. With the introduction of custom roles, this field is no longer an enum.","title":"Role ID"},"permissions":{"items":{"enum":["read-api","read-write-api","crud","read","execute","none"],"type":"string"},"type":"array","description":"Please use the /user-info/permissions api to get the permission that the user has on each feature.","x-deprecated":true,"title":"Permissions"}}},"Snmpv3Target":{"description":"This object contains SNMP v3 target/receiver where SNMP traps/notifications will be sent.","title":"SNMP v3 target","required":["user_id","server"],"x-vmw-nsx-module":"CentralConfig","type":"object","properties":{"security_level":{"default":"AUTH_PRIV","enum":["AUTH_PRIV"],"type":"string","description":"Security level indicates whether SNMP communication involves authentication and privacy protocols for this user. Value \"AUTH_PRIV\" indicates both authentication and privacy protocols will be used for SNMP communication.","title":"Security level"},"user_id":{"minLength":1,"maxLength":32,"type":"string","description":"SNMP v3 user id used to notify target server. This SNMP v3 user should already be added in this profile.","title":"Existing SNMP v3 user id"},"port":{"description":"SNMP v3 target server's port.","title":"SNMP v3 target server port","default":162,"format":"int64","maximum":65535,"minimum":1,"type":"integer"},"server":{"description":"SNMP v3 target server's IP or FQDN.","format":"hostname-or-ipv4","type":"string"}}},"GracefulRestartConfig":{"x-vmw-nsx-module":"Routing","type":"object","description":"BGP Graceful Restart configuration parameters","properties":{"graceful_restart_mode":{"description":"BGP Graceful Restart mode","default":"HELPER_ONLY","enum":["DISABLE","HELPER_ONLY","GR_AND_HELPER"],"type":"string"},"graceful_restart_timer":{"$ref":"#/definitions/GracefulRestartTimer"}},"title":"BGP Graceful Restart Configuration"},"RecommendedFeaturePermission":{"description":"Recommended Feature Permission","title":"Recommended Feature Permission","required":["src_features","target_feature","recommended_permissions"],"x-vmw-nsx-module":"AAA","type":"object","properties":{"src_features":{"items":{"type":"string"},"type":"array","description":"List of source features","title":"List of source features"},"target_feature":{"type":"string","description":"Feature","title":"Feature"},"recommended_permissions":{"items":{"type":"string"},"type":"array","description":"Permission","title":"Permission"}}},"Label":{"description":"Label that will be displayed for a UI element.","title":"Label","required":["text"],"x-vmw-nsx-module":"NsxDashboard","type":"object","properties":{"text":{"maxLength":255,"type":"string","description":"Text to be displayed at the label.","title":"Label text"},"hover":{"default":false,"type":"boolean","description":"If true, displays the label only on hover","title":"Show label only on hover"},"navigation":{"maxLength":1024,"type":"string","description":"Hyperlink of the specified UI page that provides details.","title":"Navigation to a specified UI page"},"condition":{"maxLength":1024,"type":"string","description":"If the condition is met then the label will be applied. Examples of expression syntax are provided under example_request section of CreateWidgetConfiguration API.","title":"Expression for evaluating condition"},"icons":{"minItems":0,"items":{"$ref":"#/definitions/Icon"},"type":"array","description":"Icons to be applied at dashboard for the label","title":"Icons"}}},"IpBlockSubnetListResult":{"x-vmw-nsx-module":"Ipam","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"Ipam","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/IpBlockSubnet"},"type":"array","description":"IP block subnet list results","title":"IP block subnet list results"}}}]},"EdgeTransportNodeDatapathMemoryPoolUsage":{"x-vmw-nsx-module":"ApplianceStats","type":"object","description":"Datapath memory pool usage value.","properties":{"usage":{"readOnly":true,"type":"number","description":"Percentage of memory pool in use.","title":"Percentage of memory pool in use"},"name":{"readOnly":true,"type":"string","description":"Name of the datapath memory pool as available on edge node CLI.","title":"Name of the datapath memory pool"},"description":{"readOnly":true,"type":"string","description":"Description of the memory pool.","title":"Description of the memory pool"}},"title":"Usage of datapath memory pool"},"MigrationUnitGroupStatus":{"x-vmw-nsx-module":"Migration","type":"object","properties":{"status":{"readOnly":true,"enum":["SUCCESS","FAILED","IN_PROGRESS","NOT_STARTED","PAUSING","PAUSED"],"type":"string","description":"Migration status of migration unit group","title":"Migration status of migration unit group"},"failed_count":{"readOnly":true,"format":"int32","type":"integer","description":"Number of nodes in the migration unit group that failed migration","title":"Number of nodes in the migration unit group that failed migration"},"migration_unit_count":{"readOnly":true,"format":"int32","type":"integer","description":"Number of migration units in the group","title":"Number of migration units in the group"},"group_id":{"readOnly":true,"type":"string","description":"Identifier for migration unit group","title":"UUID of migration unit group"},"percent_complete":{"readOnly":true,"type":"number","description":"Indicator of migration progress in percentage","title":"Indicator of migration progress in percentage"},"group_name":{"readOnly":true,"type":"string","description":"Name of the migration unit group","title":"Migration unit group Name"}}},"SamlTokenLoginCredential":{"x-vmw-nsx-module":"Types","allOf":[{"$ref":"#/definitions/LoginCredential"},{"x-vmw-nsx-module":"Types","type":"object","properties":{"token":{"readOnly":false,"type":"string","description":"The saml token to login to server.","title":"The saml token to login to server"},"thumbprint":{"readOnly":false,"type":"string","description":"Thumbprint of the server.","title":"Thumbprint of the server"}}}],"description":"Details of saml token based credential to login to server.","title":"A login credential specifying saml token"},"PerStepRestoreStatus":{"x-vmw-nsx-module":"ClusterRestore","type":"object","description":"Restore step status","properties":{"description":{"readOnly":true,"type":"string","description":"A description of the restore status","title":"A description of the restore status"},"value":{"readOnly":true,"enum":["INITIAL","RUNNING","SUSPENDED_BY_USER","SUSPENDED_FOR_USER_ACTION","FAILED","SUCCESS"],"type":"string","description":"Per step restore status value","title":"Per step restore status value"}},"title":"Restore step status"},"ClusterConfig":{"x-vmw-nsx-module":"ClusterManagement","allOf":[{"$ref":"#/definitions/RevisionedResource"},{"x-vmw-nsx-module":"ClusterManagement","type":"object","properties":{"control_cluster_changes_allowed":{"type":"boolean","description":"True if control cluster nodes may be added or removed","title":"True if control cluster nodes may be added or removed"},"nodes":{"items":{"$ref":"#/definitions/ClusterNodeInfo"},"type":"array","description":"Configuration of each node in cluster","title":"Configuration of each node in cluster"},"mgmt_cluster_changes_allowed":{"type":"boolean","description":"True if management cluster nodes may be added or removed","title":"True if management cluster nodes may be added or removed"},"cluster_id":{"readOnly":true,"type":"string","description":"Unique identifier of this cluster","title":"Unique identifier of this cluster"}}}]},"Footer":{"x-vmw-nsx-module":"NsxDashboard","type":"object","description":"Footer of a widget that provides additional information or allows an action such as clickable url for navigation. An example usage of footer is provided under 'example_request' section of 'CreateWidgetConfiguration' API.","properties":{"condition":{"maxLength":1024,"type":"string","description":"If the condition is met then the footer will be applied. Examples of expression syntax are provided under 'example_request' section of 'CreateWidgetConfiguration' API.","title":"Expression for evaluating condition"},"actions":{"minItems":0,"items":{"$ref":"#/definitions/FooterAction"},"type":"array","description":"Action to be performed at the footer of a widget. An action at the footer can be simple text description or a hyperlink to a UI page. Action allows a clickable url for navigation. An example usage of footer action is provided under 'example_request' section of 'CreateWidgetConfiguration' API.","title":"Footer Actions"}},"title":"Widget Footer"},"NotificationAuthenticationScheme":{"x-vmw-nsx-module":"NfwConfig","required":["scheme_name"],"type":"object","description":"NotificationAuthenticationScheme describes how notification requests should authenticate to the server.","properties":{"username":{"type":"string","description":"Username to use if scheme_name is BASIC_AUTH.","title":"Username for authentication"},"certificate_id":{"type":"string","description":"Certificate ID with a valid certificate and private key, procured from trust-management API.","title":"Valid certificate ID"},"scheme_name":{"enum":["BASIC_AUTH","CERTIFICATE"],"type":"string","description":"Authentication scheme to use when making notification requests to the partner/customer specified watcher. Specify one of BASIC_AUTH or CERTIFICATE.","title":"Authentication scheme to use when making notification requests"},"password":{"type":"string","description":"Password to use if scheme_name is BASIC_AUTH.","title":"Password for authentication"}}},"CCPUpgradeStatus":{"x-vmw-nsx-module":"Upgrade","allOf":[{"$ref":"#/definitions/ComponentUpgradeStatus"},{"x-vmw-nsx-module":"Upgrade","type":"object"}],"description":"Status of CCP upgrade","title":"Status of CCP upgrade"},"TransportNodeListResult":{"x-vmw-nsx-module":"TransportNode","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"TransportNode","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/TransportNode"},"readOnly":true,"type":"array","description":"TransportNode Results","title":"TransportNode Results"}}}],"description":"Transport Node queries result","title":"Transport Node queries result"},"ServiceInstanceStatus":{"x-vmw-nsx-module":"ServiceInsertionVMDeployment","type":"object","properties":{"instance_deployment_status":{"$ref":"#/definitions/ServiceDeploymentStatus"},"configuration_issue":{"$ref":"#/definitions/SVMConfigureIssue"},"service_instance_id":{"readOnly":true,"type":"string","description":"Id of an instantiation of a registered service.","title":"Service instance id"},"instance_health_status":{"$ref":"#/definitions/ServiceInstanceHealthStatus"}}},"ServiceInsertionRule":{"x-vmw-nsx-module":"ServiceInsertionRules","allOf":[{"$ref":"#/definitions/DSRule"},{"x-vmw-nsx-module":"ServiceInsertionRules","type":"object","properties":{"services":{"description":"List of the services. Null will be treated as any.","title":"Service List","items":{"$ref":"#/definitions/ServiceInsertionService"},"readOnly":false,"maxItems":128,"type":"array"},"redirect_tos":{"description":"A rule can be redirected to ServiceInstance, InstanceEndpoint for North/South Traffic. A rule can be redirected to ServiceChain for East/West Traffic. For REDIRECT action, redirect_tos is mandatory. For DO_NOT_REDIRECT action, redirect_tos is optional.","title":"Redirect_Tos List","items":{"$ref":"#/definitions/ResourceReference"},"readOnly":false,"maxItems":1,"type":"array"},"section_id":{"readOnly":true,"type":"string","description":"ID of the section to which this rule belongs.","title":"Section Id"}}}],"description":"ServiceInsertion Rule.","title":"ServiceInsertion Rule"},"RemoteTunnelEndpoint":{"x-vmw-nsx-module":"TransportNode","allOf":[{"$ref":"#/definitions/Endpoint"},{"x-vmw-nsx-module":"TransportNode","type":"object","properties":{"vlan":{"description":"Vlan id","format":"int64","readOnly":true,"type":"integer"}}}],"description":"Remote tunnel endpoint","title":"Remote tunnel endpoint"},"SVMConfigureIssue":{"x-vmw-nsx-module":"ServiceInsertionVMDeployment","type":"object","description":"Type of issue and detailed description of the issues in case of post-VM deployment configuration failure.","properties":{"errors":{"items":{"$ref":"#/definitions/SIErrorClass"},"type":"array","description":"List of errors along with details like errorId and error messages.","title":"List of errors"},"service_instance_id":{"type":"string","description":"The ID of service instance which was deployed.","title":"Service Instance ID"}},"title":"Service VM configuration issue"},"NodeCertificateInfo":{"x-vmw-nsx-module":"ClusterManagement","type":"object","properties":{"certificate_sha256_thumbprint":{"type":"string","description":"SHA256 of certificate","title":"SHA256 of certificate"},"certificate":{"type":"string","description":"Certificate content","title":"Certificate content"},"entity_type":{"description":"Entity type of this certificate","enum":["HTTP","DATASTORE","MANAGER","POLICY","CONTROLLER"],"type":"string"}}},"PktCapResource":{"x-vmw-nsx-module":"LiveTrace","description":"The resource of packet capture per port, such as\nthe downloading URL of packet capture file.\n","allOf":[{"$ref":"#/definitions/BasePktCapResource"},{"x-vmw-nsx-module":"LiveTrace","type":"object","properties":{"pktcap_file_download_url":{"readOnly":true,"type":"string","description":"Packet capture file download URL","title":"Packet capture file download URL"},"port_id":{"readOnly":true,"type":"string","description":"The ID of logical port where packet capture action is performed","title":"The ID of logical port where packet capture action is performed"}}}]},"PacketCaptureOption":{"x-vmw-nsx-module":"PacketCapture","type":"object","description":"The option is used to filter data on given node.","properties":{"name":{"enum":["ETHTYPE","MAC","SRCMAC","DSTMAC","VLAN","IP","SRCIP","DSTIP","IPPROTO","PORT","SRCPORT","DSTPORT","VNI","IPPROTO6","IP6","SRCIP6","DSTIP6"],"type":"string","description":"The avaiable option names in the enum can be used to filter the capture data.","title":"Packet capture option name"},"value":{"type":"string","description":"Define the capture value according to the given capture option.","title":"Packet capture option value"}},"title":"Packet capture option"},"DhcpLeases":{"x-vmw-nsx-module":"AggSvcDhcp","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"AggSvcDhcp","type":"object","properties":{"timestamp":{"type":"integer","description":"timestamp of the lease info","format":"int64"},"leases":{"description":"The lease info list of the server","title":"The lease info list of the server","minItems":0,"items":{"$ref":"#/definitions/DhcpLeasePerIP"},"maxItems":65535,"type":"array"},"dhcp_server_id":{"type":"string","description":"dhcp server uuid","title":"dhcp server uuid"}}}]},"TransportNodeCollectionState":{"x-vmw-nsx-module":"TransportNodeCollection","type":"object","description":"Realization state of attaching or detaching Transport node profile on compute collection.","properties":{"validation_errors":{"items":{"$ref":"#/definitions/ValidationError"},"type":"array","description":"Transport node profile(TNP) will not be applied to a discovered node(DN) if some validations are not passed. In this case transport node is not created or existing transport node is not updated with TNP configurations.","title":"Errors while applying transport node profile on discovered node"},"cluster_level_error":{"type":"string","description":"Errors while applying transport node profile which need cluster level action to resolve","title":"Errors which needs cluster level to resolution"},"state":{"readOnly":true,"enum":["FAILED_TO_CREATE","FAILED_TO_REALIZE","IN_PROGRESS","PROFILE_MISMATCH","SUCCESS"],"type":"string","description":"If the host preparation or transport node creation is going on for\nany host then state will be \"IN_PROGRESS\".\n\nIf setting desired state of the transport node failed for any of\nthe host then state will be \"FAILED_TO_CREATE\"\n\nIf realization of transport node failed for any of\nthe host then state will be \"FAILED_TO_REALIZE\"\n\nIf Transport node is successfully created for all of the hosts in\ncompute collection then state will be \"SUCCESS\"\n\nYou can override the configuration for one or more hosts in the\ncompute collection by update TN(transport node) request on individual\nTN. If TN is successfully created for all hosts in compute collection\nand one or more hosts have overridden configuration then transport node\ncollection state will be \"PROFILE_MISMATCH\".\n","title":"Application state of transport node template on compute collection"},"aggregate_progress_percentage":{"readOnly":true,"format":"int64","type":"integer","description":"Average of all transport node deployment progress in a cluster. Applicable only if transport node profile is applied on a cluster.","title":"Aggregate percentage of compute collection deployment"},"vlcm_transition_error":{"readOnly":true,"type":"string","description":"When vLCM is enabled on a compute collection in vSphere the transition workflow is triggered. This field indicates error in this special case.","title":"Errors while enabling vLCM on the compute collection"}},"title":"Transport node template application state"},"VendorTemplate":{"x-vmw-nsx-module":"ServiceInsertionCommonTypes","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"ServiceInsertionCommonTypes","type":"object","properties":{"vendor_template_key":{"readOnly":false,"type":"string","description":"Different VMs in data center can have Different protection levels as specified by administrator in the policy. The identifier for the policy with which the partner appliance identifies this policy. This identifier will be passed to the partner appliance at runtime to specify which protection level is applicable for the VM being protected.","title":"Vendor template key"},"attributes":{"description":"List of attributes specific to a partner for which the vendor template is created. There attributes are passed on to the partner appliance and is opaque to the NSX Manager. Attributes are not supported by guest introspection service.","title":"Vendor Template attributes","items":{"$ref":"#/definitions/Attribute"},"readOnly":false,"maxItems":128,"type":"array"},"redirection_action":{"description":"The redirection action represents if the packet is exclusively redirected to the service, or if a copy is forwarded to the service. Service profile inherits the redirection action specified at the vendor template and cannot override the action specified at the vendor template. Redirection action is not applicable to guest introspection service.","title":"Redirection action","default":"PUNT","enum":["PUNT","COPY"],"readOnly":false,"type":"string"},"functionality":{"readOnly":false,"enum":["NG_FW","IDS_IPS","NET_MON","HCX","BYOD","EPP","MPS"],"type":"string","description":"The capabilities provided by the services. Needs to be one of the following | NG_FW - Next Generation Firewall | IDS_IPS - Intrusion detection System / Intrusion Prevention System | NET_MON - Network Monitoring | HCX - Hybrid Cloud Exchange | BYOD - Bring Your Own Device | EPP - Endpoint Protection.(Third party AntiVirus partners using NXGI should use this functionality for the service) | MPS - Malware Prevention Solution","title":"Functionality Type"},"service_id":{"readOnly":true,"type":"string","description":"The service to which the vendor template belongs.","title":"Service Id"}}}],"description":"Vendor Templates are registered by the partner service manager to be used in the service profile. They contain named (k-v) pairs.","title":"Vendor Template registered for a service"},"LiveTraceActionConfig":{"x-vmw-nsx-module":"LiveTrace","type":"object","properties":{"trace_config":{"$ref":"#/definitions/TraceActionConfig"},"pktcap_config":{"$ref":"#/definitions/PktcapActionConfig"}}},"L2VpnSessionListResult":{"x-vmw-nsx-module":"L2VPN","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"L2VPN","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/L2VpnSession"},"type":"array","description":"L2VPN sessions list result","title":"L2VPN sessions list result"}}}],"description":"Paginated list all the L2VPN sessions","title":"List all L2VPN sessions"},"UpgradeUnitList":{"x-vmw-nsx-module":"Upgrade","required":["list"],"type":"object","properties":{"list":{"items":{"$ref":"#/definitions/UpgradeUnit"},"type":"array","description":"Collection of Upgrade units","title":"Collection of Upgrade units"}}},"IPPrefixList":{"x-vmw-nsx-module":"Routing","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"Routing","required":["prefixes"],"type":"object","properties":{"prefixes":{"description":"Ordered list of PrefixConfig","title":"Ordered list of PrefixConfig","minItems":1,"items":{"$ref":"#/definitions/PrefixConfig"},"maxItems":1330000,"type":"array"},"logical_router_id":{"readOnly":true,"type":"string","description":"Logical router id","title":"Logical router id"}}}]},"UpgradeCheckFailure":{"x-vmw-nsx-module":"Upgrade","type":"object","description":"Pre/post-upgrade check failure","properties":{"component_type":{"readOnly":true,"type":"string","description":"Component type of the origin of failure","title":"Component type"},"origin_name":{"readOnly":true,"type":"string","description":"Name of origin of pre/post-upgrade check failure","title":"Name of origin of failure"},"message":{"$ref":"#/definitions/UpgradeCheckFailureMessage"},"origin_id":{"readOnly":true,"type":"string","description":"Unique id of origin of pre/post-upgrade check failure","title":"Unique id of origin of failure"},"type":{"readOnly":true,"enum":["FAILURE","WARNING"],"type":"string","description":"Type of the pre/post-upgrade check failure","title":"Type of failure"},"origin_type":{"readOnly":true,"enum":["COMPONENT","UPGRADE_UNIT"],"type":"string","description":"Type of origin of pre/post-upgrade check failure","title":"Type of origin of failure"},"group_name":{"readOnly":false,"type":"string","description":"Name of the upgrade group of the origin of failure. Only applicable when\norigin_type is UPGRADE_UNIT.\n","title":"Name of upgrade group"}},"title":"Upgrade check failure"},"LbSnatIpElement":{"x-vmw-nsx-module":"LoadBalancer","required":["ip_address"],"type":"object","properties":{"ip_address":{"description":"Ip address or ip range such as 1.1.1.1 or 1.1.1.101-1.1.1.160","format":"address-or-block-or-range","type":"string"},"prefix_length":{"format":"int64","type":"integer","description":"Subnet prefix length should be not specified if there is only one single\nIP address or IP range.\n","title":"subnet prefix length"}}},"TransportNodeCollection":{"x-vmw-nsx-module":"TransportNodeCollection","allOf":[{"$ref":"#/definitions/ManagedResource"},{"required":["transport_node_profile_id","compute_collection_id"],"x-vmw-nsx-module":"TransportNodeCollection","type":"object","properties":{"has_nvds":{"type":"boolean","description":"Flag indicating if applied profile has NVDS","title":"Flag indicating if applied profile has NVDS"},"transport_node_profile_id":{"type":"string","description":"Transport Node Profile ID","title":"Transport Node Profile ID"},"compute_collection_id":{"type":"string","description":"Compute collection id","title":"Compute collection id"},"install_mode":{"readOnly":true,"enum":["MICROSEG","NORMAL"],"type":"string","description":"Flag indicating security status of Transport Node Collection","title":"Flag indicating security status of Transport Node Collection"}}}],"description":"Entity to indicate relation between Compute collection and Transport node template","title":"Compute collection transport node template"},"PackageLoggingLevels":{"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"logging_level":{"enum":["OFF","FATAL","ERROR","WARN","INFO","DEBUG","TRACE"],"type":"string","description":"Logging levels per package","title":"Logging levels per package"},"package_name":{"type":"string","description":"Package name","title":"Package name"}}},"IPAddressElement":{"x-vmw-nsx-module":"IPSet","allOf":[{"$ref":"#/definitions/RevisionedResource"},{"required":["ip_address"],"x-vmw-nsx-module":"IPSet","type":"object","properties":{"ip_address":{"description":"IPElement can be a single IP address, IP address range or a Subnet. Its\ntype can be of IPv4 or IPv6. Supported list of formats are \"192.168.1.1\",\n\"192.168.1.1-192.168.1.100\", \"192.168.0.0/24\",\n\"fe80::250:56ff:fe83:318c\",\n\"fe80::250:56ff:fe83:3181-fe80::250:56ff:fe83:318c\",\n\"fe80::250:56ff:fe83:318c/64\"\n","format":"address-or-block-or-range","type":"string"}}}],"description":"IP Address","title":"IP Address"},"Resource":{"x-vmw-nsx-module":"Common","type":"object","description":"Base class for resources","properties":{"_self":{"$ref":"#/definitions/SelfResourceLink"},"_links":{"items":{"$ref":"#/definitions/ResourceLink"},"readOnly":true,"type":"array","description":"The server will populate this field when returing the resource. Ignored on PUT and POST.","title":"References related to this resource"},"_schema":{"readOnly":true,"type":"string","description":"Schema for this resource","title":"Schema for this resource"}},"title":"Base class for resources"},"LogicalRouterPortArpCsvRecord":{"x-vmw-nsx-module":"AggSvcLogicalRouterPort","allOf":[{"$ref":"#/definitions/CsvRecord"},{"x-vmw-nsx-module":"AggSvcLogicalRouterPort","required":["ip","mac_address"],"type":"object","properties":{"ip":{"description":"The IP address","format":"ip","type":"string"},"mac_address":{"type":"string","description":"The MAC address","title":"The MAC address"}}}]},"StaticFilter":{"x-vmw-nsx-module":"NsxDashboard","type":"object","description":"Static filters","properties":{"short_display_name":{"maxLength":1024,"type":"string","description":"Property value is shown in the drop down input box for a filter. If the value is not provided 'display_name' property value is used.","title":"A property value to be shown once value is selected for a filter."},"display_name":{"maxLength":1024,"type":"string","description":"display name to be shown in the drop down for static filter.","title":"Display name for static filter"},"additional_value":{"type":"object","description":"An additional key-value pair for static filter.","title":"An additional value for static filter"},"value":{"type":"string","description":"Value of static filter inside dropdown filter.","title":"Value of static filter"}},"title":"Static filters"},"BgpNeighborListResult":{"x-vmw-nsx-module":"Routing","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"Routing","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/BgpNeighbor"},"type":"array","description":"Paginated list of bgp neighbors","title":"Paginated list of bgp neighbors"}}}]},"UpgradeBundleId":{"x-vmw-nsx-module":"Upgrade","type":"object","description":"Identifier of the upgrade bundle","properties":{"bundle_id":{"readOnly":true,"type":"string","description":"Identifier of bundle upload","title":"Bundle Id of upgrade bundle uploaded"}},"title":"Bundle id of upgrade bundle"},"BridgeEndpointListResult":{"x-vmw-nsx-module":"BridgeEndpoint","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"BridgeEndpoint","type":"object","properties":{"results":{"description":"BridgeEndpoint Results","title":"BridgeEndpoint Results","minItems":0,"items":{"$ref":"#/definitions/BridgeEndpoint"},"readOnly":true,"type":"array"}}}],"description":"Bridge Endpoint queries result","title":"Bridge Endpoint queries result"},"ServicePathHop":{"x-vmw-nsx-module":"ServiceInsertionCommonTypes","type":"object","description":"Represents a service VM implementing a particular service in a service chain","properties":{"is_active_from_dp":{"readOnly":true,"type":"boolean","description":"Indicating whether the corresponding service VM is active or not per DP.","title":"Active flag managed by DP"},"is_active_from_mp":{"readOnly":true,"type":"boolean","description":"Indicating whether the corresponding service VM is active or not per MP.","title":"Active flag managed by MP"},"vif":{"readOnly":true,"type":"string","description":"ID of the virtual network interface.","title":"Virtual interface id"},"mac_address":{"readOnly":true,"type":"string","description":"MAC address of the virtual network interface.","title":"MAC address of the virtual network interface."},"action":{"readOnly":true,"enum":["SERVICE_ACTION_INVALID","COPY","REDIRECT"],"type":"string","description":"Action that will be taken by the corresponding service VM of the hop.","title":"Action"},"is_active_from_ccp":{"readOnly":true,"type":"boolean","description":"Indicating whether the corresponding service VM is active or not per CCP.","title":"Active flag managed by CCP"},"in_maintenance_mode":{"readOnly":true,"type":"boolean","description":"Indicating the maintenance mode of the corresponding service VM.","title":"Maintenance mode flag"},"nsh_liveness_support":{"readOnly":true,"type":"boolean","description":"Indicating whether NSH liveness is supported or not by the corresponding service VM.","title":"NSH liveness flag"},"can_decrement_si":{"readOnly":true,"type":"boolean","description":"Indicating whether service is configured to decrement SI field in NSH metadata.","title":"SI decrement flag"}},"title":"Service path hop"},"LbSslCipherAndProtocolListResult":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"LoadBalancer","required":["ciphers","protocols"],"type":"object","properties":{"ciphers":{"items":{"$ref":"#/definitions/LbSslCipherInfo"},"type":"array","description":"List of SSL ciphers","title":"List of SSL ciphers"},"protocols":{"items":{"$ref":"#/definitions/LbSslProtocolInfo"},"type":"array","description":"List of SSL protocols","title":"List of SSL protocols"}}}]},"AddIntelligenceClusterNodeVMInfo":{"description":"Contains a list of NSX-Intelligence cluster node VM deployment requests and optionally\na clustering configuration.\n","title":"Info for AddIntelligenceClusterNodeVM","required":["deployment_requests"],"x-vmw-nsx-module":"NsxIntelligenceDeployment","type":"object","properties":{"deployment_requests":{"minItems":1,"items":{"$ref":"#/definitions/IntelligenceClusterNodeVMDeploymentRequest"},"type":"array","description":"Intelligence Cluster node VM deployment requests to be deployed by NSX.\n","title":"List of deployment requests"}}},"InterSRRoutingConfig":{"x-vmw-nsx-module":"Routing","type":"object","description":"Inter SR IBGP configuration","properties":{"enabled":{"default":true,"type":"boolean","description":"While creation of BGP config this flag will be set to\n- true for Tier0 logical router with Active-Active high-availability\nmode\n- false for Tier0 logical router with Active-Standby high-availability\nmode.\nUser can change this value while updating inter-sr config.\n","title":"Flag to enable inter SR IBGP"}},"title":"Inter SR IBGP configuration"},"SshKeyProperties":{"x-vmw-nsx-module":"MISSING_MODULE","allOf":[{"$ref":"#/definitions/SshKeyBaseProperties"},{"x-vmw-nsx-module":"MISSING_MODULE","required":["type","value"],"type":"object","properties":{"type":{"type":"string","description":"SSH key type","title":"SSH key type"},"value":{"type":"string","description":"SSH key value","title":"SSH key value"}}}]},"UpgradeStatusSummary":{"x-vmw-nsx-module":"MISSING_MODULE","type":"object","description":"Upgrade status summry","properties":{"upgrade_bundle_present":{"type":"boolean","description":"True if upgrade bundle is present","title":"True if upgrade bundle is present"},"upgrade_metadata":{"type":"object","description":"Meta info of upgrade","title":"Meta info of upgrade"},"upgrade_steps":{"items":{"type":"object"},"type":"array","description":"List of all upgrade steps performed","title":"List of all upgrade steps performed"}},"title":"Upgrade status summry"},"IpMacPair":{"description":"IP and MAC pair.","title":"IP and MAC pair.","required":["ip"],"x-vmw-nsx-module":"TransportNode","type":"object","properties":{"ip":{"description":"IP address","format":"ip","readOnly":false,"type":"string"},"mac":{"description":"MAC address","format":"mac-address","readOnly":false,"type":"string"}}},"VifAttachmentContext":{"x-vmw-nsx-module":"LogicalPort","allOf":[{"$ref":"#/definitions/AttachmentContext"},{"x-vmw-nsx-module":"LogicalPort","required":["vif_type"],"type":"object","properties":{"vif_type":{"enum":["PARENT","CHILD","INDEPENDENT"],"type":"string","description":"Type of the VIF attached to logical port","title":"Type of the VIF attached to logical port"},"parent_vif_id":{"type":"string","description":"VIF ID of the parent VIF if vif_type is CHILD","title":"VIF ID of the parent VIF if vif_type is CHILD"},"traffic_tag":{"format":"int32","type":"integer","description":"Current we use VLAN id as the traffic tag.\nOnly effective when vif_type is CHILD.\nEach logical port inside a container must have a\nunique traffic tag. If the traffic_tag is not\nunique, no error is generated, but traffic will\nnot be delivered to any port with a non-unique tag.\n","title":"Tag used for the traffic between this VIF and parent VIF"},"bms_interface_config":{"$ref":"#/definitions/AttachedInterface"},"app_id":{"type":"string","description":"An application ID used to identify / look up a child VIF\nbehind a parent VIF. Only effective when vif_type is CHILD.\n","title":"ID used to identify/look up a child VIF behind a parent VIF"},"transport_node_uuid":{"type":"string","description":"Only effective when vif_type is INDEPENDENT.\nEach logical port inside a bare metal server\nor container must have a transport node UUID.\nWe use transport node ID as transport node UUID.\n","title":"The UUID of the transport node"}}}]},"LogicalPortStatusSummary":{"x-vmw-nsx-module":"AggSvcLogicalPort","required":["total_ports","up_ports"],"type":"object","properties":{"total_ports":{"format":"int64","type":"integer","description":"The total number of logical ports.","title":"The total number of logical ports."},"last_update_timestamp":{"description":"Timestamp when the data was last updated; unset if data source has never updated the data.","format":"int64","readOnly":true,"type":"integer"},"up_ports":{"format":"int64","type":"integer","description":"The number of logical ports whose Operational status is UP","title":"The number of logical ports whose Operational status is UP"},"filters":{"items":{"$ref":"#/definitions/Filter"},"type":"array","description":"The filters used to find the logical ports- TransportZone id, LogicalSwitch id or LogicalSwitchProfile id","title":"The filters used to find the logical ports- TransportZone id, LogicalSwitch id or LogicalSwitchProfile id"}}},"MandatoryAccessControlProperties":{"x-vmw-nsx-module":"MISSING_MODULE","allOf":[{"$ref":"#/definitions/Resource"},{"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"status":{"readOnly":true,"enum":["ENABLED","DISABLED","ENABLED_PENDING_REBOOT"],"type":"string","description":"current status of Mandatory Access Control"},"enabled":{"type":"boolean","description":"Enabled can be True/False"}}}],"description":"Information about mandatory access control","title":"Information about mandatory access control"},"TeamingPolicy":{"description":"Uplink Teaming Policy","title":"Uplink Teaming Policy","required":["policy","active_list"],"x-vmw-nsx-module":"UplinkHostSwitchProfile","type":"object","properties":{"policy":{"enum":["FAILOVER_ORDER","LOADBALANCE_SRCID","LOADBALANCE_SRC_MAC"],"type":"string","description":"Teaming policy","title":"Teaming policy"},"standby_list":{"items":{"$ref":"#/definitions/Uplink"},"type":"array","description":"List of Uplinks used in standby list","title":"List of Uplinks used in standby list"},"active_list":{"items":{"$ref":"#/definitions/Uplink"},"type":"array","description":"List of Uplinks used in active list","title":"List of Uplinks used in active list"},"rolling_order":{"default":false,"type":"boolean","description":"Flag for preemptive mode","title":"Flag for preemptive mode"}}},"CertificateProfileListResult":{"x-vmw-nsx-module":"CertificateManager","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"CertificateManager","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/CertificateProfile"},"readOnly":false,"type":"array","description":"CertificateProfile list."}}}],"description":"CertificateProfile query result","title":"CertificateProfile query result"},"LbHttpSslCondition":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/LbRuleCondition"},{"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"client_supported_ssl_ciphers":{"items":{"description":"SSL cipher","enum":["TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256","TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384","TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA","TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA","TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA","TLS_ECDH_RSA_WITH_AES_256_CBC_SHA","TLS_RSA_WITH_AES_256_CBC_SHA","TLS_RSA_WITH_AES_128_CBC_SHA","TLS_RSA_WITH_3DES_EDE_CBC_SHA","TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA","TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256","TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384","TLS_RSA_WITH_AES_128_CBC_SHA256","TLS_RSA_WITH_AES_128_GCM_SHA256","TLS_RSA_WITH_AES_256_CBC_SHA256","TLS_RSA_WITH_AES_256_GCM_SHA384","TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA","TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256","TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256","TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384","TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384","TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA","TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256","TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256","TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384","TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384","TLS_ECDH_RSA_WITH_AES_128_CBC_SHA","TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256","TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256","TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384","TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384"],"type":"string"},"type":"array","description":"Cipher list which supported by client","title":"Cipher list which supported by client"},"client_certificate_issuer_dn":{"$ref":"#/definitions/LbClientCertificateIssuerDnCondition"},"client_certificate_subject_dn":{"$ref":"#/definitions/LbClientCertificateSubjectDnCondition"},"used_ssl_cipher":{"description":"Cipher used for an established SSL connection","enum":["TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256","TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384","TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA","TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA","TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA","TLS_ECDH_RSA_WITH_AES_256_CBC_SHA","TLS_RSA_WITH_AES_256_CBC_SHA","TLS_RSA_WITH_AES_128_CBC_SHA","TLS_RSA_WITH_3DES_EDE_CBC_SHA","TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA","TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256","TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384","TLS_RSA_WITH_AES_128_CBC_SHA256","TLS_RSA_WITH_AES_128_GCM_SHA256","TLS_RSA_WITH_AES_256_CBC_SHA256","TLS_RSA_WITH_AES_256_GCM_SHA384","TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA","TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256","TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256","TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384","TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384","TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA","TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256","TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256","TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384","TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384","TLS_ECDH_RSA_WITH_AES_128_CBC_SHA","TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256","TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256","TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384","TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384"],"type":"string"},"session_reused":{"description":"The type of SSL session reused","default":"IGNORE","enum":["IGNORE","REUSED","NEW"],"type":"string"},"used_protocol":{"description":"Protocol of an established SSL connection","enum":["SSL_V2","SSL_V3","TLS_V1","TLS_V1_1","TLS_V1_2"],"type":"string"}}}],"description":"This condition is used to match SSL handshake and SSL connection at\nall phases.If multiple properties are configured, the rule is considered\na match when all the configured properties are matched.\n","title":"Condition to match SSL handshake and SSL connection"},"BFDStatusCount":{"x-vmw-nsx-module":"Heatmap","type":"object","properties":{"bfd_admin_down_count":{"format":"int32","type":"integer","description":"Number of tunnels in BFD admin down state","title":"Number of tunnels in BFD admin down state"},"bfd_up_count":{"format":"int32","type":"integer","description":"Number of tunnels in BFD up state","title":"Number of tunnels in BFD up state"},"bfd_down_count":{"format":"int32","type":"integer","description":"Number of tunnels in BFD down state","title":"Number of tunnels in BFD down state"},"bfd_init_count":{"format":"int32","type":"integer","description":"Number of tunnels in BFD init state","title":"Number of tunnels in BFD init state"}}},"NodeServiceProperties":{"x-vmw-nsx-module":"MISSING_MODULE","allOf":[{"$ref":"#/definitions/Resource"},{"required":["service_name"],"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"service_name":{"type":"string","description":"Service name","title":"Service name"}}}],"description":"Node service properties","title":"Node service properties"},"ComputeManagerListResult":{"x-vmw-nsx-module":"InventoryCmObj","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"InventoryCmObj","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/ComputeManager"},"type":"array","description":"List of compute managers","title":"List of compute managers"}}}],"description":"List of compute managers","title":"List of compute managers"},"Pnic":{"description":"Physical NIC specification","title":"Physical NIC specification","required":["uplink_name","device_name"],"x-vmw-nsx-module":"TransportNode","type":"object","properties":{"uplink_name":{"readOnly":false,"type":"string","description":"Uplink name for this Pnic. This name will be used to reference this Pnic in other configurations.","title":"Uplink name for this Pnic. This name will be used to reference this Pnic in other configurations."},"device_name":{"readOnly":false,"type":"string","description":"device name or key","title":"device name or key"}}},"LbNodeCountPerSeverity":{"x-vmw-nsx-module":"LoadBalancer","type":"object","description":"The node count for specific load balancer usage severity.\n","properties":{"node_count":{"readOnly":true,"format":"int64","type":"integer","description":"Node count for specific serverity.\n","title":"Node count for specific serverity"},"severity":{"description":"The severity calculation is based on credit usage percentage of\nload balancer for one node.\n","enum":["GREEN","ORANGE","RED"],"readOnly":true,"type":"string"}},"title":"The node count for specific severity"},"DnsQueryAnswer":{"x-vmw-nsx-module":"DnsForwarder","type":"object","description":"Answer of nslookup","properties":{"raw_string":{"type":"string","description":"Unparsed answer string from raw_answer.\n","title":"Unparsed answer string"},"name":{"type":"string","description":"Matched name of the given address.\n","title":"Matched name"},"address":{"type":"string","description":"Can be resolved ip address.\n","title":"Matched ip address"}},"title":"Answer of nslookup"},"EdgeClusterListResult":{"x-vmw-nsx-module":"EdgeClusters","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"EdgeClusters","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/EdgeCluster"},"type":"array","description":"Edge cluster list results","title":"Edge cluster list results"}}}]},"LbSslSniCondition":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/LbRuleCondition"},{"required":["sni"],"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"case_sensitive":{"default":true,"type":"boolean","description":"If true, case is significant when comparing SNI value.\n","title":"A case sensitive flag for SNI comparing"},"match_type":{"description":"Determine how a specified string value is used to match SNI.\n","default":"REGEX","enum":["STARTS_WITH","ENDS_WITH","EQUALS","CONTAINS","REGEX"],"type":"string"},"sni":{"type":"string","description":"The SNI(Server Name indication) in client hello message.\n","title":"The server name indication"}}}],"description":"This condition is used to match SSL SNI in client hello. This condition is\nonly supported in TRANSPORT phase and HTTP_FORWARDING phase.\n","title":"Condition to match SSL SNI in client hello"},"NodeSyslogExporterPropertiesListResult":{"x-vmw-nsx-module":"MISSING_MODULE","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/NodeSyslogExporterProperties"},"type":"array","description":"Node syslog exporter results","title":"Node syslog exporter results"}}}],"description":"Node syslog exporter list results","title":"Node syslog exporter list results"},"UpgradeUnitStatusListResult":{"x-vmw-nsx-module":"Upgrade","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"Upgrade","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/UpgradeUnitStatus"},"type":"array","description":"Paged Collection of upgrade units status","title":"Paged Collection of upgrade units status"}}}]},"DnsHeader":{"x-vmw-nsx-module":"Traceflow","type":"object","properties":{"address_type":{"default":"V4","enum":["V4","V6"],"type":"string","description":"This is used to specify the type of the address. V4 - The address provided is an IPv4 domain name/IP address, the Type in query or response will be A V6 - The address provided is an IPv6 domain name/IP address, the Type in query or response will be AAAA"},"message_type":{"default":"QUERY","enum":["QUERY","RESPONSE"],"type":"string","description":"Specifies the message type whether it is a query or a response.","title":"Specifies the message type whether it is a query or a response."},"address":{"format":"hostname-or-ip","type":"string","description":"This is used to define what is being asked or responded.","title":"Domain name/IP to query/response"}}},"ManagementPlaneBaseNodeInfo":{"x-vmw-nsx-module":"ClusterManagement","type":"object","description":"The basic node info of management plane node","properties":{"uuid":{"readOnly":true,"type":"string","description":"Management plane node UUID","title":"Management plane node UUID"},"mgmt_cluster_listen_ip_address":{"readOnly":true,"type":"string","description":"The IP address of MP node","title":"The IP address of MP node"}}},"UpgradeUnitGroupInfo":{"x-vmw-nsx-module":"Upgrade","type":"object","properties":{"display_name":{"readOnly":true,"type":"string","description":"Name of the group","title":"Name of the group"},"id":{"readOnly":true,"type":"string","description":"Identifier of group","title":"UUID of group"}}},"ContainerCluster":{"x-vmw-nsx-module":"InventoryContainerObj","allOf":[{"$ref":"#/definitions/DiscoveredResource"},{"x-vmw-nsx-module":"InventoryContainerObj","type":"object","properties":{"network_status":{"readOnly":false,"enum":["HEALTHY","UNHEALTHY"],"type":"string","description":"Network status of container cluster.","title":"Network status of container cluster"},"infrastructure":{"$ref":"#/definitions/ContainerInfrastructureInfo"},"supervisor_project_id":{"readOnly":false,"type":"string","description":"Specifies supervisor container project identifier for cluster.","title":"Supervisor ContainerProject identifier for cluster"},"cluster_type":{"readOnly":false,"enum":["PAS","PKS","Kubernetes","Openshift","WCP","WCP_Guest","AKS","EKS","TKGm","TKGi","GKE","Gardener","Rancher","TAS","Other"],"type":"string","description":"Type of the container cluster. In case of creating container cluster\nfirst time, it is expected to pass the valid cluster-type.\nIn case of update, if there is no change in cluster-type, then this\nfield can be omitted in the request.\n","title":"Type of the container cluster"},"origin_properties":{"items":{"$ref":"#/definitions/KeyValuePair"},"readOnly":false,"type":"array","description":"Array of additional specific properties of container cluster\nin key-value format.\n","title":"Origin properties"},"cni_type":{"description":"Specifies Container Network Interface type for container cluster.","title":"CNI type for container cluster","default":"Other","enum":["NCP","Antrea","Other"],"readOnly":false,"type":"string"},"external_id":{"readOnly":false,"type":"string","description":"External identifier of the container cluster.","title":"External identifier of the container cluster"},"network_errors":{"items":{"$ref":"#/definitions/NetworkError"},"readOnly":false,"type":"array","description":"List of network errors related to container cluster.","title":"Network errors"}}}],"description":"Details of container cluster.","title":"Container cluster"},"ComputeCollection":{"x-vmw-nsx-module":"InventoryCmObj","allOf":[{"$ref":"#/definitions/DiscoveredResource"},{"x-vmw-nsx-module":"InventoryCmObj","type":"object","properties":{"origin_id":{"readOnly":true,"type":"string","description":"Id of the compute manager from where this Compute Collection was discovered","title":"Id of the compute manager from where this Compute Collection was discovered"},"origin_properties":{"items":{"$ref":"#/definitions/KeyValuePair"},"readOnly":true,"type":"array","description":"Key-Value map of additional specific properties of\ncompute collection in the Compute Manager\n","title":"Key-Value map of additional specific properties of\ncompute collection in the Compute Manager\n"},"external_id":{"readOnly":true,"type":"string","description":"External ID of the ComputeCollection in the source Compute manager,\ne.g. mo-ref in VC\n","title":"External ID of the ComputeCollection in the source Compute manager,\ne.g. mo-ref in VC\n"},"owner_id":{"readOnly":true,"type":"string","description":"Id of the owner of compute collection in the Compute Manager","title":"Id of the owner of compute collection in the Compute Manager"},"origin_type":{"readOnly":true,"type":"string","description":"ComputeCollection type like VC_Cluster. Here the Compute Manager\ntype prefix would help in differentiating similar named Compute\nCollection types from different Compute Managers\n","title":"ComputeCollection type like VC_Cluster. Here the Compute Manager\ntype prefix would help in differentiating similar named Compute\nCollection types from different Compute Managers\n"},"cm_local_id":{"readOnly":true,"type":"string","description":"Local Id of the compute collection in the Compute Manager","title":"Local Id of the compute collection in the Compute Manager"}}}]},"DataCounter":{"x-vmw-nsx-module":"AggSvcL2Types","required":["total"],"type":"object","properties":{"total":{"format":"int64","type":"integer","description":"The total packets or bytes","title":"The total packets or bytes"},"multicast_broadcast":{"format":"int64","type":"integer","description":"The multicast and broadcast packets or bytes","title":"The multicast and broadcast packets or bytes"},"dropped":{"format":"int64","type":"integer","description":"The dropped packets or bytes","title":"The dropped packets or bytes"}}},"NSServiceElement":{"description":"An NSService element that describes traffic corresponding to an NSService","title":"An NSService element that describes traffic corresponding to an NSService","required":["resource_type"],"discriminator":"resource_type","x-vmw-nsx-module":"Types","type":"object","properties":{"resource_type":{"enum":["EtherTypeNSService","IPProtocolNSService","IGMPTypeNSService","ICMPTypeNSService","ALGTypeNSService","L4PortSetNSService"],"type":"string","description":"The specific type of NSServiceElement","title":"The specific type of NSServiceElement"}}},"LogicalRouter":{"x-vmw-nsx-module":"LogicalRouter","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"LogicalRouter","required":["router_type"],"type":"object","properties":{"edge_cluster_member_indices":{"items":{"type":"integer","format":"int64"},"type":"array","description":"For stateful services, the logical router should be associated with\nedge cluster. For TIER 1 logical router, for manual placement of\nservice router within the cluster, edge cluster member indices needs\nto be provided else same will be auto-allocated. You can provide\nmaximum two indices for HA ACTIVE_STANDBY. For TIER0 logical router\nthis property is no use and placement is derived from logical router\nuplink or loopback port.\n","title":"Member indices of the edge node on the cluster"},"ipv6_profiles":{"$ref":"#/definitions/IPv6Profiles"},"firewall_sections":{"items":{"$ref":"#/definitions/ResourceReference"},"readOnly":true,"type":"array","description":"List of Firewall sections related to Logical Router.","title":"LR Firewall Section References"},"allocation_profile":{"$ref":"#/definitions/EdgeClusterMemberAllocationProfile"},"failover_mode":{"enum":["PREEMPTIVE","NON_PREEMPTIVE"],"type":"string","description":"Determines the behavior when a logical router instance restarts after\na failure. If set to PREEMPTIVE, the preferred node will take over,\neven if it causes another failure. If set to NON_PREEMPTIVE, then the\ninstance that restarted will remain secondary.\nThis property must not be populated unless the high_availability_mode property\nis set to ACTIVE_STANDBY.\nIf high_availability_mode property is set to ACTIVE_STANDBY and this property\nis not specified then default will be NON_PREEMPTIVE.\n","title":"Failover mode for active-standby logical router instances."},"advanced_config":{"$ref":"#/definitions/LogicalRouterConfig"},"router_type":{"enum":["TIER0","TIER1","VRF"],"type":"string","description":"TIER0 for external connectivity.\nTIER1 for two tier topology with TIER0 on top.\nVRF for isolation of routing table on TIER0.\n","title":"Type of Logical Router"},"preferred_edge_cluster_member_index":{"format":"int64","minimum":0,"type":"integer","description":"Preferred edge cluster member index which is required\nfor PREEMPTIVE failover mode. Used for Tier0 routers only.\n","title":"Preferred edge cluster member index"},"high_availability_mode":{"enum":["ACTIVE_ACTIVE","ACTIVE_STANDBY"],"type":"string","description":"High availability mode","title":"High availability mode"},"edge_cluster_id":{"type":"string","description":"Used for tier0 routers","title":"Identifier of the edge cluster for this Logical Router"}}}]},"BackupConfiguration":{"x-vmw-nsx-module":"BackupConfiguration","type":"object","description":"Configuration for taking manual/automated backup","properties":{"remote_file_server":{"$ref":"#/definitions/RemoteFileServer"},"backup_enabled":{"default":false,"type":"boolean","description":"true if automated backup is enabled","title":"true if automated backup is enabled"},"passphrase":{"type":"string","description":"Passphrase used to encrypt backup files.\nThe passphrase specified must be at least 8 characters in length and must\ncontain at least one lowercase, one uppercase, one numeric character and one\nspecial character (any other non-space character).\n","title":"Passphrase used to encrypt backup files."},"backup_schedule":{"$ref":"#/definitions/BackupSchedule"},"after_inventory_update_interval":{"description":"A number of seconds after a last backup, that needs to pass, before a topology change will trigger a generation of a new cluster/node backups. If parameter is not provided, then changes in a topology will not trigger a generation of cluster/node backups.","format":"int64","title":"A number of seconds after a last backup, that needs to pass, before a topology change will trigger a generation of a new cluster/node backups. If parameter is not provided, then changes in a topology will not trigger a generation of cluster/node backups.","maximum":86400,"minimum":300,"type":"integer"},"inventory_summary_interval":{"description":"The minimum number of seconds between each upload of the inventory summary to backup server.","title":"The minimum number of seconds between each upload of the inventory summary to backup server.","default":240,"format":"int64","maximum":3600,"minimum":30,"type":"integer"}},"title":"Configuration for taking manual/automated backup"},"IntelligenceClusterNodeVMDeploymentConfig":{"description":"Contains info used to configure the VM on deployment","title":"Configuration for deploying NSX-Intelligence cluster node VM","required":["placement_type"],"discriminator":"placement_type","x-vmw-nsx-module":"NsxIntelligenceDeployment","type":"object","properties":{"placement_type":{"enum":["IntelligenceVsphereClusterNodeVMDeploymentConfig"],"type":"string","description":"Specifies the config for the platform through which to deploy the VM\n","title":"Type of deployment"}}},"PktcapActionArgument":{"x-vmw-nsx-module":"LiveTrace","type":"object","properties":{"pktcap_type":{"readOnly":true,"enum":["UNI_DIRECTIONAL","BI_DIRECTIONAL"],"type":"string","description":"Type of packet capture","title":"Type of packet capture"},"dest_lport":{"readOnly":true,"type":"string","description":"It is required only when the type of packet capture is bidirectional. Please keep this aligned with the\ndestination logical port of trace action config when the type of trace action is bidirectional.\n","title":"Destination logical port for bidirectional packet capture"},"reverse_filter":{"$ref":"#/definitions/LiveTraceFilterData"}}},"LbHttpRequestVersionCondition":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/LbRuleCondition"},{"required":["version"],"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"version":{"description":"HTTP version","enum":["HTTP_VERSION_1_0","HTTP_VERSION_1_1"],"type":"string"}}}],"description":"This condition is used to match the HTTP protocol version of the HTTP\nrequest messages.\n","title":"Condition to match HTTP protocol version of HTTP requests"},"ServiceDeploymentConfig":{"description":"The Deployment Config contains settings that are applied during install time.","title":"Service Deployment Config","required":["compute_collection_id","compute_manager_id"],"x-vmw-nsx-module":"ServiceInsertionCommonTypes","type":"object","properties":{"storage_id":{"readOnly":false,"type":"string","description":"Moref of the datastore in VC. If it is to be taken from 'Agent VM Settings', then it should be empty.","title":"Storage Id"},"host_id":{"readOnly":false,"type":"string","description":"The service VM will be deployed on the specified host in the specified\nserver within the cluster if host_id is specified.\nNote: You must ensure that storage and specified networks are accessible\n by this host.\n","title":"Host id"},"compute_collection_id":{"readOnly":false,"type":"string","description":"Resource Pool or cluster Id.","title":"Compute Collection Id"},"vm_nic_info":{"$ref":"#/definitions/VmNicInfo"},"compute_manager_id":{"readOnly":false,"type":"string","description":"Context Id or VCenter Id.","title":"Compute Manager Id"}}},"DirectoryGroupMember":{"x-vmw-nsx-module":"DirectoryService","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"DirectoryService","required":["group_id","member_group_distinguished_name","member_group_id","group_distinguished_name","nested"],"type":"object","properties":{"group_id":{"type":"string","description":"Directory group id this group member belongs to","title":"Group idnetifier"},"member_group_distinguished_name":{"type":"string","description":"Directory group name this group member owns","title":"Member group distinguished name"},"member_group_id":{"type":"string","description":"Directory group id this group member owns","title":"Member group idnetifier"},"group_distinguished_name":{"type":"string","description":"Directory group distinguished name this group member belongs to.","title":"Group distinguished name"},"nested":{"type":"boolean","description":"Whether this member group is a directory member of the parent group speicified by group_id or a nested member group which parent group is also member group of the parent group speicified by group_id.","title":"Nesting flag"}}}]},"SftpProtocol":{"x-vmw-nsx-module":"MISSING_MODULE","allOf":[{"$ref":"#/definitions/Protocol"},{"x-vmw-nsx-module":"MISSING_MODULE","required":["ssh_fingerprint","authentication_scheme"],"type":"object","properties":{"ssh_fingerprint":{"type":"string","description":"SSH fingerprint of server","title":"SSH fingerprint of server"},"authentication_scheme":{"$ref":"#/definitions/PasswordAuthenticationScheme"}}}]},"RemoteSiteCredential":{"description":"Contains the information needed to communicate with another site.","title":"Credential of remote site","required":["username","address"],"x-vmw-nsx-module":"SiteManagerModule","type":"object","properties":{"username":{"type":"string","description":"Username of the site","title":"Username of the site"},"thumbprint":{"type":"string","description":"Sha256 thumbprint of API certificate of the remote site","title":"Sha256 thumbprint of API certificate of the remote site"},"password":{"type":"string","description":"Password of the site","title":"Password of the site"},"address":{"type":"string","description":"Address of the site (IPv4:port)","title":"Address of the site (IPv4:port)"}}},"SIErrorClass":{"x-vmw-nsx-module":"ServiceInsertionCommonTypes","type":"object","description":"Error class for all the Service Insertion related errors.","properties":{"error_id":{"readOnly":true,"type":"integer","format":"int64"},"error_message":{"readOnly":true,"type":"string"}},"title":"Error class for all the Service Insertion related errors."},"ServiceInstance":{"x-vmw-nsx-module":"ServiceInsertionCommonTypes","allOf":[{"$ref":"#/definitions/BaseServiceInstance"},{"required":["instance_deployment_template","implementation_type","attachment_point","deployed_to","deployment_spec_name","deployment_mode"],"x-vmw-nsx-module":"ServiceInsertionCommonTypes","type":"object","properties":{"deployment_spec_name":{"readOnly":false,"type":"string","description":"Name of the deployment spec to be used by this service instance.","title":"Deployment Spec Name"},"instance_deployment_template":{"$ref":"#/definitions/DeploymentTemplate"},"implementation_type":{"readOnly":false,"enum":["NORTH_SOUTH","EAST_WEST"],"type":"string","description":"Implementation to be used by this service instance for deploying the Service-VM.","title":"Implementation Type"},"attachment_point":{"readOnly":false,"enum":["TIER0_LR","TIER1_LR","SERVICE_PLANE","HOST"],"type":"string","description":"Attachment point to be used by this service instance for deploying the Service-VM.","title":"Attachment Point"},"instance_deployment_config":{"$ref":"#/definitions/InstanceDeploymentConfig"},"deployment_mode":{"description":"Deployment mode specifies where the partner appliance will be deployed in HA or non-HA i.e standalone mode.","title":"Deployment Mode","default":"ACTIVE_STANDBY","enum":["STAND_ALONE","ACTIVE_STANDBY"],"readOnly":false,"type":"string"},"deployed_to":{"description":"List of resource references where service instance be deployed. Ex. Tier 0 Logical Router in case of N-S ServiceInsertion.","title":"Deployed-to object list","minItems":1,"items":{"$ref":"#/definitions/ResourceReference"},"readOnly":false,"maxItems":128,"type":"array"},"service_deployment_id":{"readOnly":true,"type":"string","description":"Id of the Service Deployment using which the instances were deployed. Its available only for instances that were deployed using service deployment API.","title":"Id of the Service Deployment using which the instances were deployed"}}}],"description":"The deployment of a registered service. Service instance is instantiation of service. It is the most used type of instance. It is a default instance to be used when NSX handles lifecycle of appliance. Deployment and appliance related all the information is necessary.","title":"Normal Instance of a service"},"NSGroupSimpleExpression":{"x-vmw-nsx-module":"NSGroup","allOf":[{"$ref":"#/definitions/NSGroupExpression"},{"required":["target_property","target_type","value","op"],"x-vmw-nsx-module":"NSGroup","type":"object","properties":{"target_resource":{"$ref":"#/definitions/ResourceReference"},"target_property":{"type":"string","description":"Field of the resource on which this expression is evaluated","title":"Field of the resource on which this expression is evaluated"},"target_type":{"description":"Type of the resource on which this expression is evaluated","enum":["NSGroup","IPSet","MACSet","LogicalSwitch","LogicalPort","VirtualMachine","DirectoryGroup","VirtualNetworkInterface","TransportNode","CloudNativeServiceInstance","PhysicalServer","LogicalRouter","LogicalRouterPort"],"type":"string"},"value":{"type":"string","description":"Value that satisfies this expression","title":"Value that satisfies this expression"},"op":{"enum":["EQUALS","CONTAINS","STARTSWITH","ENDSWITH","NOTEQUALS"],"type":"string","description":"All operators perform a case insensitive match.\n","title":"Operator of the expression"}}}],"description":"Simple expressions to represent NSGroup membership","title":"Simple expressions to represent NSGroup membership"},"NDRAProfileListResult":{"x-vmw-nsx-module":"Routing","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"Routing","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/NDRAProfile"},"type":"array","description":"Paginated list of NDRAProfile","title":"Paginated list of NDRAProfile"}}}]},"LatencyStatProfileListResult":{"x-vmw-nsx-module":"Latency","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"Latency","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/LatencyStatProfile"},"readOnly":true,"type":"array","description":"Latency stat profile list.","title":"Latency Stat Profile List"}}}],"description":"List of latency profile","title":"List of latency profile"},"NtpProperties":{"description":"This object contains the list of NTP servers used by NSX nodes.","title":"NTP service properties","required":["servers"],"x-vmw-nsx-module":"CentralConfig","type":"object","properties":{"servers":{"items":{"description":"Hostname or IPv4 address","format":"hostname-or-ipv4","type":"string"},"type":"array","description":"List of NTP servers.","title":"NTP servers"}}},"NodeUserProperties":{"x-vmw-nsx-module":"MISSING_MODULE","allOf":[{"$ref":"#/definitions/Resource"},{"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"username":{"minLength":1,"maxLength":32,"type":"string","description":"User login name (must be \"root\" if userid is 0)","title":"User login name (must be \"root\" if userid is 0)"},"status":{"readOnly":true,"enum":["ACTIVE","PASSWORD_EXPIRED","NOT_ACTIVATED"],"type":"string","description":"Status of the user. This value can be ACTIVE indicating authentication attempts will be successful if the correct credentials are specified. The value can also be PASSWORD_EXPIRED indicating authentication attempts will fail because the user's password has expired and must be changed. Or, this value can be NOT_ACTIVATED indicating the user's password has not yet been set and must be set before the user can authenticate.","title":"User status"},"last_password_change":{"description":"Number of days since password was last changed","title":"Number of days since password was last changed","format":"int64","maximum":2147483647,"readOnly":true,"minimum":0,"type":"integer"},"full_name":{"type":"string","description":"Full name for the user","title":"Full name for the user"},"password_change_frequency":{"description":"Number of days password is valid before it must be changed. This can be set to 0 to indicate no password change is required or a positive integer up to 9999. By default local user passwords must be changed every 90 days.","format":"int64","title":"Number of days password is valid before it must be changed","maximum":9999,"minimum":0,"type":"integer"},"password_reset_required":{"type":"boolean","description":"Boolean value that states if a password reset is required","title":"Boolean value that states if a password reset is required"},"password":{"type":"string","description":"Password for the user (optionally specified on PUT, unspecified on GET)","title":"Password for the user (optionally specified on PUT, unspecified on GET)"},"userid":{"description":"Numeric id for the user","title":"Numeric id for the user","format":"int64","maximum":2147483647,"readOnly":true,"minimum":0,"type":"integer"},"old_password":{"type":"string","description":"Old password for the user (required on PUT if password specified)","title":"Old password for the user (required on PUT if password specified)"}}}],"description":"Node user properties","title":"Node user properties"},"MigrationUnitList":{"x-vmw-nsx-module":"Migration","required":["list"],"type":"object","properties":{"list":{"items":{"$ref":"#/definitions/MigrationUnit"},"type":"array","description":"Collection of Migration units","title":"Collection of Migration units"}}},"IPSecVPNIKEProfile":{"x-vmw-nsx-module":"IPSecVPN","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"IPSecVPN","type":"object","properties":{"digest_algorithms":{"items":{"description":"The IKEDigestAlgorithms are used to verify message\nintegrity during IKE negotiation. SHA1 produces 160\nbits hash and SHA2_XXX produces XXX bit hash.\n","enum":["SHA1","SHA2_256","SHA2_384","SHA2_512"],"type":"string"},"type":"array","description":"Algorithm to be used for message digest during Internet Key Exchange(IKE) negotiation. Default is SHA2_256.","title":"Algorithm for message hash"},"encryption_algorithms":{"items":{"description":"IKEEncryption algorithms are used to ensure confidentiality of\nthe messages exchanged during IKE negotiations. AES stands for\nAdvanced Encryption Standards. AES_128 uses 128-bit keys whereas\nAES_256 uses 256-bit keys for encryption and decryption. AES_128\nand AES_256 use CBC mode of encryption. AES_GCM stands for\nAdvanced Encryption Standard(AES) in Galois/Counter Mode(GCM) and\nis used to provide both confidentiality and data origin\nauthentication. AES_GCM composed of two separate functions one\nfor encryption(AES) and one for authentication(GMAC). AES_GCM\nalgorithms will be available with IKE_V2 version only.\nAES_GCM_128 uses 128-bit keys.\nAES_GCM_192 uses 192-bit keys.\nAES_GCM_256 uses 256-bit keys.\n","enum":["AES_128","AES_256","AES_GCM_128","AES_GCM_192","AES_GCM_256"],"type":"string"},"type":"array","description":"Encryption algorithm is used during Internet Key Exchange(IKE) negotiation. Default is AES_128.","title":"Encryption algorithm for IKE"},"dh_groups":{"items":{"description":"Diffie-Hellman groups represent algorithm used to derive shared\nkeys between IPSec VPN initiator and responder over an\nunsecured network.\nGROUP2 uses 1024-bit Modular Exponentiation (MODP) group.\nGROUP5 uses 1536-bit MODP group.\nGROUP14 uses 2048-bit MODP group.\nGROUP15 uses 3072-bit MODP group.\nGROUP16 uses 4096-bit MODP group.\nGROUP19 uses 256-bit random Elliptic Curve (ECP) group.\nGROUP20 uses 384-bit random ECP group.\nGROUP21 uses 521-bit random ECP group.\n","enum":["GROUP2","GROUP5","GROUP14","GROUP15","GROUP16","GROUP19","GROUP20","GROUP21"],"type":"string"},"type":"array","description":"Diffie-Hellman group to be used if PFS is enabled. Default is GROUP14.","title":"DH group"},"sa_life_time":{"description":"Life time for security association. Default is 86400 seconds (1 day).","title":"Security association (SA) life time","default":86400,"format":"int64","maximum":31536000,"minimum":21600,"type":"integer"},"ike_version":{"default":"IKE_V2","enum":["IKE_V1","IKE_V2","IKE_FLEX"],"type":"string","description":"IKE protocol version to be used. IKE-Flex will initiate IKE-V2 and responds to both IKE-V1 and IKE-V2.","title":"IKE version"}}}],"description":"IKE Profile is a reusable profile that captures IKE phase one negotiation parameters. Any changes affects all IPSec VPN sessions consuming this profile.","title":"Internet key exchange (IKE) profile"},"IDSSignatureDetail":{"x-vmw-nsx-module":"IDSSignatures","type":"object","properties":{"affected_product":{"type":"string","description":"Product affected by the signature.","title":"Affected product"},"direction":{"type":"string","description":"Source-destination direction.","title":"Direction"},"protocol":{"type":"string","description":"Protocol used in the packet analysis.","title":"Protocol"},"class_type":{"type":"string","description":"Class type of the signature.","title":"Signature class type"},"enabled":{"type":"boolean","description":"Signature enabled.","title":"Enabled"},"action":{"type":"string","description":"Packet analysis action","title":"Action"},"tag":{"items":{"type":"string"},"type":"array","description":"Vendor assigned classification tag.","title":"Signature tag"},"malware_family":{"type":"string","description":"Family of the malware tracked in the signature.","title":"Malware Family"},"name":{"type":"string","description":"Name of the signature.","title":"Signature name"},"category":{"items":{"type":"string"},"type":"array","description":"VMware defined signature category.","title":"Category"},"cvssv3":{"type":"string","description":"Signature CVSSV3 score.","title":"Signature CVSSV3 score"},"cvssv2":{"type":"string","description":"Signature CVSSV2 score.","title":"Signature CVSSV2 score"},"severity":{"type":"string","description":"VMware defined signature severity.","title":"Severity"},"signature_revision":{"format":"int64","type":"integer","description":"The revision of the signature","title":"Signature revision"},"performance_impact":{"type":"string","description":"Performance impact of the signature.","title":"Performance impact"},"flow":{"type":"string","description":"Flow established from server, from client etc.","title":"Flow established"},"signature_severity":{"type":"string","description":"Signature vendor set severity of the signature rule.","title":"Signature severity"},"urls":{"items":{"type":"string"},"type":"array","description":"List of mitre attack URLs pertaining to signature.","title":"List of mitre attack URLs pertaining to signature"},"policy":{"items":{"type":"string"},"type":"array","description":"Signature policy.","title":"Policy"},"attack_target":{"type":"string","description":"Target of the attack tracked in the signature.","title":"Attack target"},"signature_id":{"format":"int64","type":"integer","description":"Unique ID of the signature rule.","title":"The signature ID"},"cves":{"items":{"type":"string"},"type":"array","description":"CVE of the signature.","title":"CVE of the signature"},"type":{"items":{"type":"string"},"type":"array","description":"Signature type.","title":"Type"},"cvss":{"type":"string","description":"Represents the cvss value of a Signature.\nThe value is derived from cvssv3 or cvssv2 score.\nIf cvssv3 exists, then this is the cvssv3 score, else\nit is the cvssv2 score.\n","title":"Signature CVSS score"},"resource_type":{"readOnly":true,"type":"string","description":"IDSSignatureDetail resource type.","title":"IDSSignatureDetail resource type"}}},"CustomFilterWidgetConfiguration":{"x-vmw-nsx-module":"NsxDashboard","allOf":[{"$ref":"#/definitions/FilterWidgetConfiguration"},{"required":["ui_component_identifier"],"x-vmw-nsx-module":"NsxDashboard","type":"object","properties":{"ui_component_identifier":{"type":"string","description":"User defined filter component selector to be rendered inside view/container.","title":"UI identifier for filter component to be rendered inside view/container"}}}],"description":"Represents configuration for custom filter widget. For this widget the data source is not applicable. It defines ui identifer for filter UI component and render it on dashboard view. This configuration can only be used for system owned widgets.","title":"Custom Filter widget Configuration"},"TraceflowObservationListResult":{"x-vmw-nsx-module":"Traceflow","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"Traceflow","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/TraceflowObservation"},"type":"array","description":"TraceflowObservation list results","title":"TraceflowObservation list results"}}}]},"DuplicateIPDetection":{"x-vmw-nsx-module":"IpDiscoverySwitchingProfile","type":"object","description":"Duplicate IP detection and control","properties":{"duplicate_ip_detection_enabled":{"default":false,"readOnly":false,"type":"boolean","description":"Indicates whether duplicate IP detection should be enabled","title":"Indicates whether duplicate IP detection should be enabled"}},"title":"Duplicate IP detection and control"},"MirrorStackStatusListResult":{"x-vmw-nsx-module":"PortMirroring","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"PortMirroring","required":["overall_status","results"],"type":"object","properties":{"overall_status":{"description":"SUCCESS if all the TN's stack status are SUCCESS,\nFAILED if some of the TN's stack status are FAILED.\n","enum":["UNKNOWN","SUCCESS","FAILED"],"type":"string"},"results":{"items":{"$ref":"#/definitions/TnNodeStackSpanStatus"},"type":"array","description":"List all TN nodes which spaned in remote L3 mirror session mirror\nstack health status detailed info, including mirror stack status,\nvmknic status, TN node ID, TN node name and last updated status timestamp.\n","title":"All TN nodes in remote L3 mirror session mirror stack health status"}}}]},"IPPrefixListListResult":{"x-vmw-nsx-module":"Routing","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"Routing","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/IPPrefixList"},"type":"array","description":"Paginated list of IPPrefixLists","title":"Paginated list of IPPrefixLists"}}}]},"PoolUsage":{"x-vmw-nsx-module":"Ipam","type":"object","description":"Pool usage statistics in a pool.","properties":{"total_ids":{"readOnly":true,"format":"int64","type":"integer","description":"Total number of IDs in a pool","title":"Total number of IDs in a pool"},"allocated_ids":{"readOnly":true,"format":"int64","type":"integer","description":"Total number of allocated IDs in a pool","title":"Total number of allocated IDs in a pool"},"free_ids":{"readOnly":true,"format":"int64","type":"integer","description":"Total number of free IDs in a pool","title":"Total number of free IDs in a pool"}}},"IPSecVPNSessionStatus":{"x-vmw-nsx-module":"VPNStatistics","type":"object","description":"IKE session traffic summary provides IKE session status and aggregate of traffic across all tunnel.","properties":{"ipsec_vpn_session_id":{"readOnly":true,"type":"string","description":"UUID of vpn session.","title":"Session identifier"},"display_name":{"readOnly":true,"type":"string","description":"Display name of vpn session.","title":"Display name"},"failed_tunnels":{"readOnly":true,"format":"int64","type":"integer","description":"Number of failed tunnels.","title":"Failed tunnels"},"negotiated_tunnels":{"readOnly":true,"format":"int64","type":"integer","description":"Number of negotiated tunnels.","title":"Negotiated tunnels"},"session_status":{"readOnly":true,"enum":["UP","DOWN","DEGRADED"],"type":"string","description":"Gives session status consolidated using IKE status and tunnel status. It can be UP, DOWN, DEGRADED. If IKE and all tunnels are UP status will be UP, if all down it will be DOWN, otherwise it will be DEGRADED.","title":"Session status"},"last_update_timestamp":{"description":"Timestamp when the data was last updated.","format":"int64","readOnly":true,"type":"integer"},"aggregate_traffic_counters":{"$ref":"#/definitions/IPSecVPNTrafficCounters"},"ike_status":{"$ref":"#/definitions/IPSecVPNIKESessionStatus"},"total_tunnels":{"readOnly":true,"format":"int64","type":"integer","description":"Total number of tunnels.","title":"Total tunnels"}},"title":"IKE session traffic summary"},"IPAddressElementListResult":{"x-vmw-nsx-module":"IPSet","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"IPSet","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/IPAddressElement"},"type":"array","description":"IP address element list","title":"IP address element list"}}}],"description":"Collection of IP address elements","title":"Collection of IP address elements"},"IPSecVPNLocalEndpoint":{"x-vmw-nsx-module":"IPSecVPN","allOf":[{"$ref":"#/definitions/ManagedResource"},{"required":["ipsec_vpn_service_id","local_address"],"x-vmw-nsx-module":"IPSecVPN","type":"object","properties":{"ipsec_vpn_service_id":{"$ref":"#/definitions/ResourceReference"},"trust_ca_ids":{"items":{"type":"string"},"type":"array","description":"Certificate authority (CA) identifier list to verify peer certificates.","title":"Certificate authority (CA) identifiers"},"local_id":{"type":"string","description":"Local identifier.","title":"Local identifier"},"local_address":{"description":"IPV4 Address for local endpoint.","format":"ipv4","type":"string"},"certificate_id":{"type":"string","description":"Site certificate identifier.","title":"Certificate Id"},"trust_crl_ids":{"items":{"type":"string"},"type":"array","description":"Certificate revocation list (CRL) identifier list of peer certificates.","title":"Certificate revocation list (CRL) Identifiers"}}}],"description":"Local endpoint represents a logical router on which tunnel needs to be terminated.","title":"IPSec VPN Local Endpoint"},"RoleWithFeatures":{"x-vmw-nsx-module":"AAA","allOf":[{"$ref":"#/definitions/ManagedResource"},{"required":["features"],"x-vmw-nsx-module":"AAA","type":"object","properties":{"role":{"readOnly":true,"type":"string","description":"Short identifier for the role. Must be all lower case with no spaces.","title":"Role identifier"},"features":{"items":{"$ref":"#/definitions/FeaturePermission"},"type":"array","description":"Features","title":"Features"}}}],"description":"Role","title":"Role"},"RouteMapSequenceSet":{"x-vmw-nsx-module":"Routing","type":"object","properties":{"prefer_global_v6_next_hop":{"default":false,"type":"boolean","description":"For incoming and import route_maps on receiving both v6 global\nand v6 link-local address for the route, prefer to use the global\naddress as the next hop. By default, it prefers the link-local next hop.\n","title":"Prefer global v6 next hop over local next hop"},"local_preference":{"description":"Local preference indicates the degree of preference for one BGP route\nover other BGP routes. The path/route with highest local preference\nvalue is preferred/selected. If local preference value is not specified\nthen it will be considered as 100 by default.\n","format":"int64","title":"Local preference number","maximum":4294967295,"minimum":0,"type":"integer"},"weight":{"description":"Weight used to select certain path","format":"int32","title":"Weight used to select certain path","maximum":65535,"minimum":0,"type":"integer"},"large_community":{"type":"string","description":"Set large BGP community, community value shoud be in aa:bb:nn format where aa, bb, nn are unsigned integers with range [1-4294967295].","title":"Set large BGP community"},"as_path_prepend":{"type":"string","description":"As Path Prepending to influence path selection","title":"As Path Prepending to influence path selection"},"community":{"type":"string","description":"Set normal BGP community either well-known community name or\ncommunity value in aa:nn(2byte:2byte) format.\n","title":"Set normal BGP community"},"multi_exit_discriminator":{"description":"Multi Exit Discriminator (MED)","format":"int64","title":"Multi Exit Discriminator (MED)","maximum":4294967295,"minimum":0,"type":"integer"}}},"UpgradeUnitGroupListResult":{"x-vmw-nsx-module":"Upgrade","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"Upgrade","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/UpgradeUnitGroup"},"type":"array","description":"Paged Collection of Upgrade unit groups","title":"Paged Collection of Upgrade unit groups"}}}]},"SessionLoginCredential":{"x-vmw-nsx-module":"Types","allOf":[{"$ref":"#/definitions/LoginCredential"},{"x-vmw-nsx-module":"Types","type":"object","properties":{"session_id":{"readOnly":false,"type":"string","description":"The session_id to login to server.","title":"The session_id to login to server"},"thumbprint":{"readOnly":false,"type":"string","description":"Thumbprint of the login server.","title":"Thumbprint of the login server"}}}],"description":"Details of session based login credential to login to server.","title":"A login credential specifying session_id"},"MPAConfigProperties":{"x-vmw-nsx-module":"MISSING_MODULE","allOf":[{"$ref":"#/definitions/Resource"},{"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"RmqClientType":{"description":"The nodes client type."},"RmqBrokerCluster":{"items":{"$ref":"#/definitions/BrokerProperties"},"type":"array","description":"The list of messaging brokers this controller is configured with."},"SharedSecret":{"type":"string","description":"The shared secret to use when autnenticating to the management plane's message bus. Not returned in REST responses."},"AccountName":{"readOnly":false,"description":"The account name to use when authenticating to the management plane's message bus."}}}],"description":"Information about the management plane this node is communciating with","title":"Information about the management plane this node is communciating with"},"LbHttpRequestHeaderCondition":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/LbRuleCondition"},{"required":["header_value","header_name"],"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"header_value":{"type":"string","description":"Value of HTTP header","title":"Value of HTTP header"},"case_sensitive":{"default":true,"type":"boolean","description":"If true, case is significant when comparing HTTP header value.\n","title":"A case sensitive flag for HTTP header value comparing"},"match_type":{"description":"Match type of HTTP header value","default":"REGEX","enum":["STARTS_WITH","ENDS_WITH","EQUALS","CONTAINS","REGEX"],"type":"string"},"header_name":{"type":"string","description":"Name of HTTP header","title":"Name of HTTP header"}}}],"description":"This condition is used to match HTTP request messages by HTTP header\nfields. HTTP header fields are components of the header section of HTTP\nrequest and response messages. They define the operating parameters of an\nHTTP transaction. For example, Cookie, Authorization, User-Agent, etc. One\ncondition can be used to match one header field, to match multiple header\nfields, multiple conditions must be specified.\nThe match_type field defines how header_value field is used to match HTTP\nrequests. The header_name field does not support match types.\n","title":"Condition to match HTTP request header"},"LbPoolMemberStatistics":{"x-vmw-nsx-module":"AggSvcLb","required":["statistics","ip_address"],"type":"object","properties":{"statistics":{"$ref":"#/definitions/LbStatisticsCounter"},"ip_address":{"description":"Pool member IP address","format":"ip","type":"string"},"port":{"description":"The port is configured in pool member. For virtual server port range\ncase, pool member port must be null.\n","format":"port-or-range","type":"string"}}},"BackupOperationHistory":{"x-vmw-nsx-module":"BackupConfiguration","type":"object","description":"Past backup operation details","properties":{"inventory_backup_statuses":{"items":{"$ref":"#/definitions/BackupOperationStatus"},"type":"array","description":"Statuses of previous inventory backups","title":"Statuses of previous inventory backups"},"cluster_backup_statuses":{"items":{"$ref":"#/definitions/BackupOperationStatus"},"type":"array","description":"Statuses of previous cluser backups","title":"Statuses of previous cluser backups"},"node_backup_statuses":{"items":{"$ref":"#/definitions/BackupOperationStatus"},"type":"array","description":"Statuses of previous node backups","title":"Statuses of previous node backups"}},"title":"Past backup operation details"},"IdfwVirtualMachineStatus":{"description":"ID and status of the VM on Identity Firewall compute collection.\n","title":"IDFW VM ID and status.","required":["vm_status","vm_id"],"x-vmw-nsx-module":"IdentityFirewall","type":"object","properties":{"vm_status":{"items":{"$ref":"#/definitions/IdfwVirtualMachineCondition"},"type":"array","description":"Status of the Identity Firewall compute collection's Virtual Machine.\n","title":"IDFW VM status."},"vm_id":{"type":"string","description":"VM ID of the VM on Identity Firewall compute collection.\n","title":"IDFW Virtual Machine ID."}}},"LogicalRouterPortArpEntry":{"x-vmw-nsx-module":"AggSvcLogicalRouterPort","required":["ip","mac_address"],"type":"object","properties":{"ip":{"description":"The IP address","format":"ip","type":"string"},"mac_address":{"type":"string","description":"The MAC address","title":"The MAC address"}}},"BatchResponse":{"description":"The reponse to a batch operation","title":"The reponse to a batch operation","required":["results"],"x-vmw-nsx-module":"Common","type":"object","properties":{"has_errors":{"type":"boolean","description":"Indicates if any of the APIs failed","title":"errors indicator"},"rolled_back":{"type":"boolean","description":"Optional flag indicating that all items were rolled back even if succeeded initially","title":"indicates if all items were rolled back."},"results":{"items":{"$ref":"#/definitions/BatchResponseItem"},"type":"array","description":"Bulk list results","title":"Bulk list results"}}},"LogicalRouterPortCounters":{"x-vmw-nsx-module":"AggSvcLogicalRouterPort","type":"object","properties":{"no_arp_dropped_packets":{"format":"int64","type":"integer","description":"Number of no ARP packets dropped.","title":"The number of no ARP packets dropped"},"dropped_packets":{"format":"int64","type":"integer","description":"The total number of packets dropped.","title":"The number of dropped packets"},"no_mem_dropped_packets":{"format":"int64","type":"integer","description":"Number of packets dropped due to insufficient memory.","title":"The number of no memory packets dropped"},"ipsec_pol_err_dropped_packets":{"format":"int64","type":"integer","description":"Number of IPSec policy error packets dropped.","title":"The number of IPSec policy error packets dropped"},"no_linked_dropped_packets":{"format":"int64","type":"integer","description":"Number of packets dropped as no linked ports are present.","title":"The number of no linked packets dropped"},"kni_dropped_packets":{"format":"int64","type":"integer","description":"Number of DPDK kernal NIC interface packets dropped.","title":"The number of kernal NIC interface packets dropped"},"blocked_packets":{"format":"int64","type":"integer","description":"The total number of packets blocked.","title":"The number of blocked packets"},"rpf_check_dropped_packets":{"format":"int64","type":"integer","description":"Number of reverse-path forwarding check packets dropped.","title":"The number of reverse-path forwarding check packets dropped"},"ipsec_pol_block_dropped_packets":{"format":"int64","type":"integer","description":"Number of IPSec policy block packets dropped.","title":"The number of IPSec policy block packets dropped"},"dad_dropped_packets":{"format":"int64","type":"integer","description":"Number of duplicate address detected packets dropped.","title":"The number of duplicate address detected packets dropped"},"no_receiver_dropped_packets":{"format":"int64","type":"integer","description":"Number of packets dropped due to absence of receiver.","title":"The number of no receiver packets dropped"},"l4port_unsupported_dropped_packets":{"format":"int64","type":"integer","description":"Number of packets dropped due to unsupported L4 port.","title":"The number of L4 port unsupported packets dropped"},"frag_needed_dropped_packets":{"format":"int64","type":"integer","description":"Number of fragmentation needed packets dropped.","title":"The number of fragmentation needed packets dropped"},"destination_unsupported_dropped_packets":{"format":"int64","type":"integer","description":"Number of packtes dropped as destination is not supported.","title":"The number of destination unsupported packets dropped"},"firewall_dropped_packets":{"format":"int64","type":"integer","description":"Number of firewall packets dropped.","title":"The number of firewall packets dropped"},"no_route_dropped_packets":{"format":"int64","type":"integer","description":"The number of no route packets dropped","title":"The number of no route packets dropped"},"malformed_dropped_packets":{"format":"int64","type":"integer","description":"Number of packtes dropped as they are malformed.","title":"The number of malformed packets dropped"},"non_ip_dropped_packets":{"format":"int64","type":"integer","description":"Number of non IP packets dropped.","title":"The number of non IP packets dropped"},"ipsec_dropped_packets":{"format":"int64","type":"integer","description":"Number of IPSec packets dropped","title":"The number of IPSec packets dropped"},"redirect_dropped_packets":{"format":"int64","type":"integer","description":"Number of redirect packets dropped.","title":"The number of redirect packets dropped"},"service_insert_dropped_packets":{"format":"int64","type":"integer","description":"Number of service insert packets dropped.","title":"The number of service insert packets dropped"},"ipsec_no_vti_dropped_packets":{"format":"int64","type":"integer","description":"Number of IPSec packets dropped as no VTI is present.","title":"The number of IPSec no VTI packets dropped"},"total_packets":{"format":"int64","type":"integer","description":"The total number of packets transferred.","title":"The total number of packets"},"proto_unsupported_dropped_packets":{"format":"int64","type":"integer","description":"Number of packets dropped as protocol is unsupported.","title":"The number of protocol unsupported packets dropped"},"ttl_exceeded_dropped_packets":{"format":"int64","type":"integer","description":"Number of time to live exceeded packets dropped.","title":"The number of time to live exceeded packets dropped"},"ipv6_dropped_packets":{"format":"int64","type":"integer","description":"Number of IPV6 packets dropped.","title":"The number of IPV6 packets dropped"},"ipsec_no_sa_dropped_packets":{"format":"int64","type":"integer","description":"Number of IPSec no security association packets dropped.","title":"The number of IPSec no security association packets dropped"},"total_bytes":{"format":"int64","type":"integer","description":"The total number of bytes transferred.","title":"The total number of bytes"}}},"LbRuleAction":{"description":"Load balancer rule actions are used to manipulate application traffic.\nCurrently load balancer rules can be used at three load balancer processing\nphases. Each phase has its own supported type of actions.\nSupported actions in HTTP_REQUST_REWRITE phase are:\n LbHttpRequestUriRewriteAction\n LbHttpRequestHeaderRewriteAction\n LbHttpRequestHeaderDeleteAction\n LbVariableAssignmentAction\nSupported actions in HTTP_FORWARDING phase are:\n LbHttpRejectAction\n LbHttpRedirectAction\n LbSelectPoolAction\n LbVariablePersistenceOnAction\n LbConnectionDropAction\nSupported action in HTTP_RESPONSE_REWRITE phase is:\n LbHttpResponseHeaderRewriteAction\n LbHttpResponseHeaderDeleteAction\n LbVariablePersistenceLearnAction\nSupported action in HTTP_ACCESS phase is:\n LbJwtAuthAction\n LbConnectionDropAction\n LbVariableAssignmentAction\nSupported action in TRANSPORT phase is:\n LbSslModeSelectionAction\n LbSelectPoolAction\n\nIf the match type of an LbRuleCondition field is specified as REGEX and\nnamed capturing groups are used in the specified regular expression. The\ngroups can be used as variables in LbRuleAction fields.\nFor example, define a rule with LbHttpRequestUriCondition as match\ncondition and LbHttpRequestUriRewriteAction as action. Set match_type field\nof LbHttpRequestUriCondition to REGEX, and set uri field to\n \"/news/(?<year>\\d+)/(?<month>\\d+)/(?<article>.*)\".\nSet uri field of LbHttpRequestUriRewriteAction to:\n \"/news/$year-$month/$article\"\nIn uri field of LbHttpRequestUriCondition, the (?<year>\\d+),\n(?<month>\\d+) and (?<article>.*) are named capturing groups,\nthey define variables named $year, $month and $article respectively. The\ndefined variables are used in LbHttpRequestUriRewriteAction.\nFor a matched HTTP request with URI \"/news/2017/06/xyz.html\", the substring\n\"2017\" is captured in variable $year, \"06\" is captured in variable $month,\nand \"xyz.html\" is captured in variable $article. The\nLbHttpRequestUriRewriteAction will rewrite the URI to:\n \"/news/2017-06/xyz.html\"\nA set of built-in variables can be used in LbRuleAction as well. The name\nof built-in variables start with underscore, the name of user defined\nvariables is not allowed to start with underscore.\nFollowing are some of the built-in variables:\n $_scheme: Reference the scheme part of matched HTTP messages, could be\n\"http\" or \"https\".\n $_host: Host of matched HTTP messages, for example \"www.example.com\".\n $_server_port: Port part of URI, it is also the port of the server which\naccepted a request. Default port is 80 for http and 443 for https.\n $_uri: The URI path, for example \"/products/sample.html\".\n $_request_uri: Full original request URI with arguments, for example,\n \"/products/sample.html?a=b&c=d\".\n $_args: URI arguments, for instance \"a=b&c=d\"\n $_is_args: \"?\" if a request has URI arguments, or an empty string\notherwise.\nFor the full list of built-in variables, please reference the NSX-T\nAdministrator's Guide.\n","title":"Load balancer rule action","required":["type"],"discriminator":"type","x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"type":{"description":"The property identifies the load balancer rule action type.\n","enum":["LbHttpRequestUriRewriteAction","LbHttpRequestHeaderRewriteAction","LbHttpRejectAction","LbHttpRedirectAction","LbSelectPoolAction","LbSelectServerAction","LbHttpResponseHeaderRewriteAction","LbHttpRequestHeaderDeleteAction","LbHttpResponseHeaderDeleteAction","LbVariableAssignmentAction","LbVariablePersistenceOnAction","LbVariablePersistenceLearnAction","LbJwtAuthAction","LbSslModeSelectionAction","LbConnectionDropAction"],"type":"string"}}},"IDSSummaryListResult":{"x-vmw-nsx-module":"IDSMetrics","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"IDSMetrics","type":"object","properties":{"results":{"description":"Paged collection of the detected intrusions.","title":"Paged collection of intrusions","items":{"$ref":"#/definitions/IDSEventsSummary"},"readOnly":true,"maxItems":100,"type":"array"}}}],"description":"List of all intrusions that are detected grouped by signature with\ntheir summary.\n","title":"List of intrusions with their summary"},"DirectoryDomainListResults":{"x-vmw-nsx-module":"DirectoryService","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"DirectoryService","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/DirectoryDomain"},"type":"array","description":"List of Directory Domains","maxItems":500,"title":"List of Directory Domains"}}}],"description":"List of Directory Domain","title":"List of Directory Domain"},"MigrationFeedbackSummaryListResult":{"x-vmw-nsx-module":"Migration","allOf":[{"$ref":"#/definitions/ListResult"},{"required":["results"],"x-vmw-nsx-module":"Migration","type":"object","properties":{"feedback_resolution_job_status":{"readOnly":true,"enum":["RUNNING","NOT_RUNNING"],"type":"string","description":"Feedback resolution job status","title":"Feedback resolution job status"},"results":{"items":{"$ref":"#/definitions/MigrationFeedbackCategory"},"readOnly":false,"type":"array","description":"Paged Collection of feedback categories","title":"Paged Collection of feedback categories"}}}],"description":"List of feedback categories and count of requests in each category.","title":"List of feedback categories for Migration"},"BatchRequestItem":{"description":"A single request within a batch of operations","title":"A single request within a batch of operations","required":["uri","method"],"x-vmw-nsx-module":"Common","type":"object","properties":{"body":{"type":"object"},"uri":{"type":"string","description":"relative uri (path and args), of the call including resource id (if this is a POST/DELETE), exclude hostname and port and prefix, exploded form of parameters","title":"Internal uri of the call"},"method":{"enum":["GET","POST","PUT","DELETE","PATCH"],"type":"string","description":"http method type","title":"method type(POST/PUT/DELETE/UPDATE)"}}},"SyslogConfiguration":{"description":"Syslog server configuration parameters","title":"Syslog server configuration","required":["server"],"x-vmw-nsx-module":"FabricNode","type":"object","properties":{"log_level":{"default":"INFO","enum":["EMERGENCY","ALERT","CRITICAL","ERROR","WARNING","NOTICE","INFO","DEBUG"],"type":"string","description":"Log level that needs to be redirected.\n","title":"Log level to be redirected"},"protocol":{"default":"UDP","enum":["TCP","UDP","TLS","LI","LI_TLS"],"type":"string","description":"Supported Syslog protocol.\n","title":"Syslog protocol"},"port":{"description":"Syslog server listening port.\n","default":"514","format":"port-or-range","type":"string"},"name":{"type":"string","description":"Display name of the syslog server","title":"Display name of the syslog server"},"server":{"type":"string","description":"Syslog server Ip or fqdn.\n","title":"Server Ip or fqdn"}}},"DSSection":{"x-vmw-nsx-module":"DistributedServices","allOf":[{"$ref":"#/definitions/ManagedResource"},{"x-vmw-nsx-module":"DistributedServices","required":["stateful","section_type"],"type":"object","properties":{"stateful":{"readOnly":false,"type":"boolean","description":"Stateful or Stateless nature of distributed service section is enforced on all rules inside the section. Layer3 sections can be stateful or stateless. Layer2 sections can only be stateless.","title":"Stateful nature of the distributed service rules in the section."},"is_default":{"readOnly":true,"type":"boolean","description":"It is a boolean flag which reflects whether a distributed service section is default section or not. Each Layer 3 and Layer 2 section will have at least and at most one default section.","title":"Default section flag"},"applied_tos":{"description":"List of objects where the rules in this section will be enforced. This will take precedence over rule level appliedTo.","title":"AppliedTo List","items":{"$ref":"#/definitions/ResourceReference"},"readOnly":false,"maxItems":128,"type":"array"},"rule_count":{"readOnly":true,"format":"int64","type":"integer","description":"Number of rules in this section.","title":"Rule count"},"section_type":{"readOnly":false,"enum":["LAYER2","LAYER3","L3REDIRECT","IDS"],"type":"string","description":"Type of the rules which a section can contain. Only homogeneous sections are supported.","title":"Section Type"}}}]},"AgentStatusCount":{"x-vmw-nsx-module":"Heatmap","type":"object","properties":{"status":{"enum":["UP","DOWN","UNKNOWN"],"type":"string","description":"Roll-up agent status","title":"Roll-up agent status"},"down_count":{"format":"int32","type":"integer","description":"Down count","title":"Down count"},"agents":{"items":{"$ref":"#/definitions/AgentStatus"},"type":"array","description":"List of agent statuses belonging to the transport node","title":"NSX agents status"},"up_count":{"format":"int32","type":"integer","description":"Up count","title":"Up count"}}},"TnNodeAgentstatus":{"x-vmw-nsx-module":"TnContainerStatus","required":["hyperbus_connection_status","vif_id"],"type":"object","properties":{"hyperbus_connection_status":{"description":"Show the Node Agent connected VM vif status.","enum":["UNKNOWN","HEALTHY","UNHEALTHY","DEGRADED"],"type":"string"},"vif_id":{"type":"string","description":"Connected VM vif id.","title":"Connected VM VIF id"}}},"LbIcmpMonitor":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/LbActiveMonitor"},{"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"data_length":{"description":"The data size(in byte) of the ICMP healthcheck packet","title":"The data size(in byte) of the ICMP healthcheck packet","default":56,"format":"int64","maximum":65507,"minimum":0,"type":"integer"}}}]},"IPv6DhcpServer":{"x-vmw-nsx-module":"Dhcp","type":"object","description":"DHCP server to support IPv6 DHCP service. Properties defined at DHCP server\nlevel can be overridden by ip-pool or static-binding level properties.\n","properties":{"dhcp_server_ip":{"description":"DHCP server ip in CIDR format.","format":"ipv6-cidr-block","type":"string"},"server_id":{"readOnly":true,"type":"string","description":"DHCP server id.","title":"DHCP server id"},"dns_nameservers":{"description":"Primary and secondary DNS server address to assign host. They can be\noverridden by ip-pool or static-binding level property.\n","title":"DNS ips","minItems":0,"items":{"description":"IPv6 address","format":"ipv6","type":"string"},"maxItems":2,"type":"array"},"sntp_servers":{"description":"SNTP server ips.","title":"SNTP server ips","minItems":0,"items":{"description":"IPv6 address","format":"ipv6","type":"string"},"maxItems":2,"type":"array"},"domain_names":{"items":{"type":"string"},"type":"array","description":"Host name or prefix to be assigned to host. It can be overridden by\nip-pool or static-binding level property.\n","title":"Domain name"}},"title":"DHCP server to support IPv6 DHCP service"},"PolicyTraceflowObservationDroppedLogical":{"x-vmw-nsx-module":"PolicyConnectivity","allOf":[{"$ref":"#/definitions/TraceflowObservationDroppedLogical"},{"x-vmw-nsx-module":"PolicyConnectivity","type":"object","properties":{"nat_rule_path":{"readOnly":true,"type":"string","description":"The path of the NAT rule that was applied to forward the traceflow packet","title":"Network Address Translation Rule Path"},"jumpto_rule_path":{"readOnly":true,"type":"string","description":"The path of the jump-to rule that was applied to the traceflow packet","title":"Jump-to Rule Path"},"component_path":{"readOnly":true,"type":"string","description":"The path of the component that dropped the traceflow packet","title":"The path of the component that dropped the traceflow packet"},"segment_port_path":{"readOnly":true,"type":"string","description":"The path of the segment port at which traceflow packet was dropped","title":"The path of the segment port at which traceflow packet was dropped"},"l2_rule_path":{"readOnly":true,"type":"string","description":"The path of the l2 rule that was applied to the traceflow packet","title":"L2 Rule Path"},"acl_rule_path":{"readOnly":true,"type":"string","description":"The path of the ACL rule that was applied to forward the traceflow packet","title":"Access Control List Rule Path"}}}]},"CertificateList":{"x-vmw-nsx-module":"CertificateManager","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"CertificateManager","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/Certificate"},"readOnly":true,"type":"array","description":"Certificate list."}}}],"description":"Certificate queries result","title":"Certificate queries result"},"LbClientSslProfile":{"x-vmw-nsx-module":"LoadBalancer","description":"The object is deprecated as NSX-T Load Balancer is deprecated.\n","allOf":[{"$ref":"#/definitions/LbSslProfile"},{"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"session_cache_enabled":{"default":true,"type":"boolean","description":"SSL session caching allows SSL client and server to reuse previously\nnegotiated security parameters avoiding the expensive public key\noperation during handshake.\n","title":"session cache enable/disable flag"},"session_cache_timeout":{"description":"Session cache timeout specifies how long the SSL session parameters\nare held on to and can be reused.\n","title":"SSL session cache timeout value","default":300,"format":"int64","maximum":86400,"minimum":1,"type":"integer"},"cipher_group_label":{"description":"It is a label of cipher group which is mostly consumed by GUI.\n","enum":["BALANCED","HIGH_SECURITY","HIGH_COMPATIBILITY","CUSTOM"],"type":"string"},"is_fips":{"readOnly":true,"type":"boolean","description":"This flag is set to true when all the ciphers and protocols are FIPS\ncompliant. It is set to false when one of the ciphers or protocols are\nnot FIPS compliant..\n","title":"FIPS compliance of ciphers and protocols"},"is_secure":{"readOnly":true,"type":"boolean","description":"This flag is set to true when all the ciphers and protocols are secure.\nIt is set to false when one of the ciphers or protocols is insecure.\n","title":"Secure/Insecure SSL profile flag"},"prefer_server_ciphers":{"default":true,"type":"boolean","description":"During SSL handshake as part of the SSL client Hello client sends an\nordered list of ciphers that it can support (or prefers) and typically\nserver selects the first one from the top of that list it can also\nsupport. For Perfect Forward Secrecy(PFS), server could override the\nclient's preference.\n","title":"prefer server ciphers flag"},"ciphers":{"items":{"description":"SSL cipher","enum":["TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256","TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384","TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA","TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA","TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA","TLS_ECDH_RSA_WITH_AES_256_CBC_SHA","TLS_RSA_WITH_AES_256_CBC_SHA","TLS_RSA_WITH_AES_128_CBC_SHA","TLS_RSA_WITH_3DES_EDE_CBC_SHA","TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA","TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256","TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384","TLS_RSA_WITH_AES_128_CBC_SHA256","TLS_RSA_WITH_AES_128_GCM_SHA256","TLS_RSA_WITH_AES_256_CBC_SHA256","TLS_RSA_WITH_AES_256_GCM_SHA384","TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA","TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256","TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256","TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384","TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384","TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA","TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256","TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256","TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384","TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384","TLS_ECDH_RSA_WITH_AES_128_CBC_SHA","TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256","TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256","TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384","TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384"],"type":"string"},"type":"array","description":"supported SSL cipher list to client side","title":"supported SSL cipher list to client side"},"protocols":{"items":{"description":"SSL protocol","enum":["SSL_V2","SSL_V3","TLS_V1","TLS_V1_1","TLS_V1_2"],"type":"string"},"type":"array","description":"SSL versions TLS1.1 and TLS1.2 are supported and enabled by default.\nSSLv2, SSLv3, and TLS1.0 are supported, but disabled by default.\n","title":"supported SSL protocol list to client side"}}}]},"LbClientCertificateSubjectDnCondition":{"description":"Match condition for client certficate subject DN","title":"Match condition for client certficate subject DN","required":["subject_dn"],"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"case_sensitive":{"default":true,"type":"boolean","description":"If true, case is significant when comparing subject DN value.\n","title":"A case sensitive flag for subject DN comparing"},"match_type":{"description":"Match type of subject DN","default":"REGEX","enum":["STARTS_WITH","ENDS_WITH","EQUALS","CONTAINS","REGEX"],"type":"string"},"subject_dn":{"type":"string","description":"Value of subject DN","title":"Value of subject DN"}}},"IdfwVmStats":{"description":"Identity Firewall user login/session data for a single VM.","title":"Identity Firewall user login/session data for a single VM","required":["vm_ext_id","active_sessions"],"x-vmw-nsx-module":"IdentityFirewall","type":"object","properties":{"vm_ext_id":{"type":"string","description":"Virtual machine (external ID or BIOS UUID) where login/logout event occurred.","title":"Virtual machine external ID or BIOS UUID"},"active_sessions":{"items":{"$ref":"#/definitions/IdfwUserSessionData"},"type":"array","description":"List of active (still logged in) user login/sessions data (no limit)","title":"List of active (still logged in) user login/sessions data (no limit)"},"archived_sessions":{"items":{"$ref":"#/definitions/IdfwUserSessionData"},"type":"array","description":"Optional list of up to 5 most recent archived (previously logged in) user login/session data.","title":"Optional list of archived (previously logged in) user login/session data (maximum 5)"}}},"IntelligenceFormFactor":{"x-vmw-nsx-module":"MISSING_MODULE","type":"object","description":"Napp cluster form factor","properties":{"vcpu":{"readOnly":true,"format":"int64","type":"integer","description":"Number of virtual cpus on the Napp worker nodes","title":"Number of virtual cpus on the Napp worker nodes"},"default_worker_count":{"readOnly":true,"format":"int64","type":"integer","description":"Default number of Napp worker nodes.","title":"Default number of Napp worker nodes."},"disk":{"readOnly":true,"format":"int64","type":"integer","description":"Disk size of the Napp worker nodes in GBs.","title":"Disk size of the Napp worker nodes in GBs"},"type":{"description":"NSX Intelligence node form factor type\n","enum":["EVALUATION","STANDARD","ADVANCED","SMALL","LARGE","EXTRA_LARGE"],"readOnly":true,"type":"string"},"memory":{"readOnly":true,"format":"int64","type":"integer","description":"Memory size of the Napp worker nodes in GBs","title":"Memory size of the Napp worker nodes in GBs"}},"title":"Napp cluster form factor"},"UpgradeCheckInfo":{"description":"Meta-data of a pre/post-upgrade check","title":"Meta-data of a pre/post-upgrade check","required":["component_type"],"x-vmw-nsx-module":"Upgrade","type":"object","properties":{"name":{"readOnly":true,"type":"string","description":"Display name of the pre/post-upgrade check","title":"Name of the upgrade check"},"component_type":{"readOnly":false,"type":"string","description":"Component type of the pre/post-upgrade check","title":"Component type"},"description":{"readOnly":true,"type":"string","description":"Description of the pre/post-upgrade check","title":"Description"}}},"LbFastUdpProfile":{"x-vmw-nsx-module":"LoadBalancer","allOf":[{"$ref":"#/definitions/LbAppProfile"},{"x-vmw-nsx-module":"LoadBalancer","type":"object","properties":{"idle_timeout":{"description":"Though UDP is a connectionless protocol, for the purposes of load\nbalancing, all UDP packets with the same flow signature (source and\ndestination IP/ports and IP protocol) received within the idle timeout\nperiod are considered to belong to the same connection and are sent to\nthe same backend server. If no packets are received for idle timeout\nperiod, the connection (association between flow signature and the\nselected server) is cleaned up.\n","title":"UDP idle timeout in seconds","default":300,"format":"int64","maximum":2147483647,"minimum":1,"type":"integer"},"flow_mirroring_enabled":{"default":false,"type":"boolean","description":"If flow mirroring is enabled, all the flows to the bounded virtual\nserver are mirrored to the standby node.\n","title":"flow mirroring enabled flag"}}}]},"BundleId":{"x-vmw-nsx-module":"FileUploadFramework","type":"object","description":"Identifier of the bundle.","properties":{"bundle_id":{"readOnly":true,"type":"string","description":"Identifier of bundle upload","title":"Bundle Id"}},"title":"Id of bundle"},"TransportNodeProfileListResult":{"x-vmw-nsx-module":"TransportNodeProfile","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"TransportNodeProfile","type":"object","properties":{"results":{"items":{"$ref":"#/definitions/TransportNodeProfile"},"readOnly":true,"type":"array","description":"TransportNodeProfile Results","title":"TransportNodeProfile Results"}}}],"description":"Transport Node Profile queries result","title":"Transport Node Profile queries result"},"ClusterNodeEntity":{"description":"NSX Cluster is made up of multiple cluster nodes. Each node can perform multiple functions, commonly referred to as roles. Cluster node entities are processes running in a cluster node that assist in the performance of a role. Cluster Boot Manager is a daemon that securely bootstraps and configures the entities. This type contains attributes of a cluster node entity that are relevant to the Cluster Boot Manager.","title":"Cluster Node Entity Properties","required":["entity_uuid","certificate","entity_type"],"x-vmw-nsx-module":"Cluster","type":"object","properties":{"certificate":{"type":"string","description":"Public certificate of the entity in PEM format","title":"Public certificate of the entity in PEM format"},"entity_uuid":{"type":"string","description":"UUID of the entity","title":"UUID of the entity"},"entity_type":{"enum":["MANAGER","CONTROLLER","POLICY","HTTPS","CLUSTER_BOOT_MANAGER","DATASTORE","GLOBAL_MANAGER","ASYNC_REPLICATOR","MONITORING","IDPS_REPORTING","CORFU_NONCONFIG","UPGRADE_COORDINATOR","CM-INVENTORY","MESSAGING-MANAGER"],"type":"string","description":"Type of the entity","title":"Type of the entity"},"subnet_prefix_length":{"description":"Subnet mask prefix length of the entity binds to","format":"int64","title":"Subnet mask prefix length of the entity binds to","maximum":32,"minimum":0,"type":"integer"},"ip_address":{"type":"string","description":"IP address the entity binds to","title":"IP address the entity binds to"},"fqdn":{"format":"hostname","type":"string","description":"Domain name the entity binds to","title":"Domain name the entity binds to"},"port":{"description":"Port the entity binds to","format":"int64","title":"Port the entity binds to","maximum":65535,"minimum":0,"type":"integer"}}},"QosBaseRateShaper":{"description":"A shaper configuration entry that specifies type and metrics","title":"A shaper configuration entry that specifies type and metrics","required":["enabled","resource_type"],"discriminator":"resource_type","x-vmw-nsx-module":"QosSwitchingProfile","type":"object","properties":{"enabled":{"type":"boolean"},"resource_type":{"enum":["IngressRateShaper","IngressBroadcastRateShaper","EgressRateShaper"],"type":"string"}}},"ActionableResourceListResult":{"x-vmw-nsx-module":"ClusterRestore","allOf":[{"$ref":"#/definitions/ListResult"},{"x-vmw-nsx-module":"ClusterRestore","required":["results"],"type":"object","properties":{"results":{"items":{"$ref":"#/definitions/ActionableResource"},"type":"array","description":"List results","title":"List results"}}}]},"CsvListResult":{"x-vmw-nsx-module":"CsvTypes","type":"object","description":"Base type for CSV result.","properties":{"file_name":{"type":"string","description":"File name set by HTTP server if API returns CSV result as a file.","title":"File name"}}},"LogicalPortMirrorSource":{"x-vmw-nsx-module":"PortMirroring","allOf":[{"$ref":"#/definitions/MirrorSource"},{"x-vmw-nsx-module":"PortMirroring","required":["port_ids"],"type":"object","properties":{"port_ids":{"minItems":1,"items":{"type":"string"},"type":"array","description":"Source logical port identifier list","title":"Source logical port identifier list"}}}]},"CloudNativeServiceInstance":{"x-vmw-nsx-module":"InventoryCloudObj","description":"Stores the information about cloud native service instance.","allOf":[{"$ref":"#/definitions/DiscoveredResource"},{"x-vmw-nsx-module":"InventoryCloudObj","type":"object","properties":{"service_type":{"readOnly":true,"type":"string","description":"Type of cloud native service.","title":"Type of cloud native service; possible values are ELB, RDS"},"source":{"$ref":"#/definitions/ResourceReference"},"external_id":{"readOnly":true,"type":"string","description":"Id of service instance fetched from public cloud.\n","title":"External id of cloud native service instance in the system."}}}]},"GracefulRestartTimer":{"x-vmw-nsx-module":"Routing","type":"object","description":"BGP Graceful Restart timers configuration","properties":{"restart_timer":{"description":"Maximum time BGP speaker will take for the BGP session to be\nre-established after a restart. Ranges from 1 sec to 3600 sec.\nThis can be used to speed up routing convergence by its peer in\ncase that the BGP speaker does not come back after a restart.\nIf the session does not get re-established within the \"Restart Time\"\nthat the Restarting Speaker advertised previously, the Receiving\nSpeaker will delete all the stale routes from that peer.\n","title":"Restart Timer","default":180,"format":"int64","maximum":3600,"minimum":1,"type":"integer"},"stale_timer":{"description":"Maximum time before stale routes are removed from the RIB when the\nlocal BGP process restarts. Ranges from 1 sec to 3600 sec.\n","title":"Stale Timer","default":600,"format":"int64","maximum":3600,"minimum":1,"type":"integer"}},"title":"BGP Graceful Restart Timer"},"ManagementConfig":{"x-vmw-nsx-module":"ConfigManagement","allOf":[{"$ref":"#/definitions/RevisionedResource"},{"x-vmw-nsx-module":"ConfigManagement","required":["publish_fqdns"],"type":"object","properties":{"publish_fqdns":{"type":"boolean","description":"True if Management nodes publish their fqdns(instead of default IP addresses) across NSX for its reachability.","title":"True if Management nodes publish their fqdns(instead of default IP addresses) across NSX for its reachability."}}}]},"NodeAuthProviderVidmProperties":{"description":"Node AAA provider vIDM properties","title":"Node AAA provider vIDM properties","required":["node_host_name","host_name","client_id","thumbprint"],"x-vmw-nsx-module":"MISSING_MODULE","type":"object","properties":{"client_secret":{"type":"string","description":"vIDM client secret","title":"vIDM client secret"},"host_name":{"type":"string","description":"Fully Qualified Domain Name(FQDN) of vIDM","title":"Fully Qualified Domain Name(FQDN) of vIDM"},"client_id":{"type":"string","description":"vIDM client id","title":"vIDM client id"},"vidm_enable":{"type":"boolean","description":"vIDM enable flag","title":"vIDM enable flag"},"lb_enable":{"type":"boolean","description":"Load Balancer enable flag","title":"Load Balancer enable flag"},"thumbprint":{"type":"string","description":"Hexadecimal SHA256 hash of the vIDM server's X.509 certificate","title":"vIDM certificate thumbprint"},"node_host_name":{"type":"string","description":"host name to use when creating the redirect URL for clients to follow after authenticating to vIDM","title":"host name of the node redirected to"}}},"WeeklyBackupSchedule":{"x-vmw-nsx-module":"BackupConfiguration","allOf":[{"$ref":"#/definitions/BackupSchedule"},{"required":["days_of_week","minute_of_day","hour_of_day"],"x-vmw-nsx-module":"BackupConfiguration","type":"object","properties":{"days_of_week":{"description":"Days of week when backup is taken. 0 - Sunday, 1 - Monday, 2 - Tuesday, 3 - Wednesday ...","title":"Days of week when backup is taken. 0 - Sunday, 1 - Monday, 2 - Tuesday, 3 - Wednesday ...","minItems":1,"items":{"type":"integer","format":"int64"},"maxItems":7,"uniqueItems":true,"type":"array"},"minute_of_day":{"description":"Time of day when backup is taken","format":"int64","title":"Time of day when backup is taken","maximum":59,"minimum":0,"type":"integer"},"hour_of_day":{"description":"Time of day when backup is taken","format":"int64","title":"Time of day when backup is taken","maximum":23,"minimum":0,"type":"integer"}}}],"description":"Schedule to specify day of the week and time to take automated backup","title":"Schedule to specify day of the week and time to take automated backup"}},"parameters":{},"responses":{"NotExtended":{"description":"Not Extended","schema":{"$ref":"#/definitions/ApiError"}},"RequestTimeout":{"description":"Request Timeout","schema":{"$ref":"#/definitions/ApiError"}},"RequestEntityTooLarge":{"description":"Request Entity Too Large","schema":{"$ref":"#/definitions/ApiError"}},"EnhanceYourCalm":{"description":"Enhance Your Calm","schema":{"$ref":"#/definitions/ApiError"}},"NetworkAuthenticationRequired":{"description":"Network Authentication Required","schema":{"$ref":"#/definitions/ApiError"}},"Conflict":{"description":"Conflict","schema":{"$ref":"#/definitions/ApiError"}},"ExpectationFailed":{"description":"Expectation Failed","schema":{"$ref":"#/definitions/ApiError"}},"PaymentRequired":{"description":"Payment Required","schema":{"$ref":"#/definitions/ApiError"}},"PreconditionRequired":{"description":"Precondition Required","schema":{"$ref":"#/definitions/ApiError"}},"BandwidthLimitExceeded":{"description":"Bandwidth Limit Exceeded","schema":{"$ref":"#/definitions/ApiError"}},"ReservedforWebDAV":{"description":"Reserved for WebDAV","schema":{"$ref":"#/definitions/ApiError"}},"RequestedRangeNotSatisfiable":{"description":"Requested Range Not Satisfiable","schema":{"$ref":"#/definitions/ApiError"}},"InsufficientStorage":{"description":"Insufficient Storage","schema":{"$ref":"#/definitions/ApiError"}},"NotFound":{"description":"Not Found","schema":{"$ref":"#/definitions/ApiError"}},"InternalServerError":{"description":"Internal Server Error","schema":{"$ref":"#/definitions/ApiError"}},"ClientClosedRequest":{"description":"Client Closed Request","schema":{"$ref":"#/definitions/ApiError"}},"UpgradeRequired":{"description":"Upgrade Required","schema":{"$ref":"#/definitions/ApiError"}},"MethodNotAllowed":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ApiError"}},"LengthRequired":{"description":"Length Required","schema":{"$ref":"#/definitions/ApiError"}},"UnavailableForLegalReasons":{"description":"Unavailable For Legal Reasons","schema":{"$ref":"#/definitions/ApiError"}},"Iamateapot":{"description":"I am a teapot","schema":{"$ref":"#/definitions/ApiError"}},"FailedDependency":{"description":"Failed Dependency","schema":{"$ref":"#/definitions/ApiError"}},"GatewayTimeout":{"description":"Gateway Timeout","schema":{"$ref":"#/definitions/ApiError"}},"NoResponse":{"description":"No Response","schema":{"$ref":"#/definitions/ApiError"}},"ServiceUnavailable":{"description":"Service Unavailable","schema":{"$ref":"#/definitions/ApiError"}},"UnsupportedMediaType":{"description":"Unsupported Media Type","schema":{"$ref":"#/definitions/ApiError"}},"Locked":{"description":"Locked","schema":{"$ref":"#/definitions/ApiError"}},"BadGateway":{"description":"Bad Gateway","schema":{"$ref":"#/definitions/ApiError"}},"BadRequest":{"description":"Bad Request","schema":{"$ref":"#/definitions/ApiError"}},"NotAcceptable":{"description":"Not Acceptable","schema":{"$ref":"#/definitions/ApiError"}},"HTTPVersionNotSupported":{"description":"HTTP Version Not Supported","schema":{"$ref":"#/definitions/ApiError"}},"UnprocessableEntity":{"description":"Unprocessable Entity","schema":{"$ref":"#/definitions/ApiError"}},"RetryWith":{"description":"Retry With","schema":{"$ref":"#/definitions/ApiError"}},"NotImplemented":{"description":"Not Implemented","schema":{"$ref":"#/definitions/ApiError"}},"Request-URITooLong":{"description":"Request-URI Too Long","schema":{"$ref":"#/definitions/ApiError"}},"Unauthorized":{"description":"Unauthorized","schema":{"$ref":"#/definitions/ApiError"}},"PreconditionFailed":{"description":"Precondition Failed","schema":{"$ref":"#/definitions/ApiError"}},"LoopDetected":{"description":"Loop Detected","schema":{"$ref":"#/definitions/ApiError"}},"Gone":{"description":"Gone","schema":{"$ref":"#/definitions/ApiError"}},"Forbidden":{"description":"Forbidden","schema":{"$ref":"#/definitions/ApiError"}},"TooManyRequests":{"description":"Too Many Requests","schema":{"$ref":"#/definitions/ApiError"}},"BlockedbyWindowsParentalControls":{"description":"Blocked by Windows Parental Controls","schema":{"$ref":"#/definitions/ApiError"}},"ProxyAuthenticationRequired":{"description":"Proxy Authentication Required","schema":{"$ref":"#/definitions/ApiError"}},"VariantAlsoNegotiates":{"description":"Variant Also Negotiates","schema":{"$ref":"#/definitions/ApiError"}},"RequestHeaderFieldsTooLarge":{"description":"Request Header Fields Too Large","schema":{"$ref":"#/definitions/ApiError"}}},"tags":[{"name":"Port Connection"},{"name":"IKE Sessions Status"},{"name":"User Interface Service"},{"name":"Support-Bundle"},{"name":"Port Mirroring"},{"name":"Policy Service"},{"name":"Routing BFD Configuration"},{"name":"Deployments"},{"name":"IPSEC Sessions Summary"},{"name":"NAT"},{"name":"Certificates"},{"name":"Site Management"},{"name":"Nodes"},{"name":"Messaging Manager Service"},{"name":"NTP"},{"name":"Peer Endpoints"},{"name":"Routing Configuration"},{"name":"NS Profiles"},{"name":"Install Upgrade Service"},{"name":"Backup Restore Management"},{"name":"Notifications"},{"name":"Service Configuration"},{"name":"Appliance Management"},{"name":"Services"},{"name":"Traceflow"},{"name":"Packet Capture"},{"name":"LLDP"},{"name":"Roles"},{"name":"Virtual Machines"},{"name":"Setup"},{"name":"Vmgroup"},{"name":"L2VPN Session Status"},{"name":"Metadata Proxy"},{"name":"Transport Node Profiles"},{"name":"IKE Service"},{"name":"Telemetry Service"},{"name":"Realization Data"},{"name":"Process"},{"name":"Form Factors"},{"name":"L2VPN Session Statistics"},{"name":"Proxy Settings"},{"name":"Health Checks"},{"name":"Logical Bridging"},{"name":"Edge Clusters"},{"name":"Manager Network Interfaces"},{"name":"Migration"},{"name":"L2VPN Sessions Summary"},{"name":"IPSEC Reset Sessions Statistics"},{"name":"Error Resolver"},{"name":"Grouping Objects"},{"name":"Statistics"},{"name":"Networking"},{"name":"Fabric"},{"name":"User Management"},{"name":"Latency Profiles"},{"name":"API Services"},{"name":"Node Management"},{"name":"Logical Router Ports"},{"name":"Audit Logs"},{"name":"NSX Intelligence"},{"name":"Migration Coordinator Service"},{"name":"Upgrade Units"},{"name":"Inventory"},{"name":"IP Blocks"},{"name":"Logical Switch Ports"},{"name":"Cluster Certificate"},{"name":"File Store"},{"name":"Transport Node Tunnels"},{"name":"CRL"},{"name":"Associations"},{"name":"Search Service"},{"name":"Cluster Status"},{"name":"Healthcheck"},{"name":"IDS Profiles"},{"name":"VIDM Configuration"},{"name":"Task Management"},{"name":"Migration Units"},{"name":"Service Insertion"},{"name":"IP Pools"},{"name":"Configuration"},{"name":"Virtual Interfaces"},{"name":"NSX Manager"},{"name":"Bridge Endpoint Profiles"},{"name":"Lifecycle Management"},{"name":"Capacity Dashboard"},{"name":"Settings"},{"name":"Support Bundle"},{"name":"NSX Platform Client"},{"name":"UI Views"},{"name":"Profiles"},{"name":"Idps Reporting Service"},{"name":"Core Dumps"},{"name":"Cluster Profiles"},{"name":"VNI Pools"},{"name":"Security"},{"name":"Mpa Configuration"},{"name":"NSX Message Service"},{"name":"Widget Configuration"},{"name":"CSR"},{"name":"Container Applications"},{"name":"Compute Collections"},{"name":"Logs"},{"name":"Cluster Node Deployments"},{"name":"LDAP Servers"},{"name":"Cluster Interfaces"},{"name":"HTTP Service"},{"name":"Tunnel Profiles"},{"name":"Syslog"},{"name":"NS Groups"},{"name":"Transport Nodes"},{"name":"SSH"},{"name":"IPSEC Sessions Statistics"},{"name":"Virtual Switches"},{"name":"Upgrade Coordinator"},{"name":"Search API"},{"name":"Fabric Nodes"},{"name":"Upgrade"},{"name":"Monitoring"},{"name":"Discovered Nodes"},{"name":"Certificate"},{"name":"Identity Firewall"},{"name":"NSX Component Administration"},{"name":"Directory Service"},{"name":"Bundles"},{"name":"Access Token"},{"name":"Network Interfaces"},{"name":"Upgrade Agent"},{"name":"Log Insight"},{"name":"Physical Servers"},{"name":"Stats"},{"name":"Manager Service"},{"name":"Logical Routers"},{"name":"Principal Identity"},{"name":"NSX Managers"},{"name":"Status"},{"name":"DHCP Relay Profiles"},{"name":"Repository"},{"name":"Troubleshooting And Monitoring"},{"name":"NS Services"},{"name":"Management Plane"},{"name":"Host"},{"name":"Global Configurations"},{"name":"Plan"},{"name":"Groups"},{"name":"IKE Profiles"},{"name":"System Health"},{"name":"Realization State Barrier"},{"name":"IPSEC"},{"name":"Search"},{"name":"Transport Zone Profiles"},{"name":"Appliance"},{"name":"Management Plane API"},{"name":"Tasks"},{"name":"Dashboard"},{"name":"DNS"},{"name":"Transport Node Status"},{"name":"Backup"},{"name":"Alarms And Events"},{"name":"Loadbalancer"},{"name":"History"},{"name":"Cluster Virtual IP"},{"name":"Transport Node Interfaces"},{"name":"Hardening"},{"name":"Feedback"},{"name":"Firewall"},{"name":"IPFIX"},{"name":"SNMP"},{"name":"Dashboards"},{"name":"System Properties"},{"name":"Logical Switching"},{"name":"MAC Sets"},{"name":"Plugins"},{"name":"DHCP"},{"name":"Container Projects"},{"name":"DHCP Relay"},{"name":"Routing"},{"name":"Transport Node Collections"},{"name":"Hostswitch Profiles"},{"name":"Container"},{"name":"Group"},{"name":"User Inputs"},{"name":"Telemetry"},{"name":"Cluster Manager Service"},{"name":"BFD Peers"},{"name":"VTEP Label Pools"},{"name":"Policy"},{"name":"Clusters"},{"name":"Containers"},{"name":"Cluster Configuration"},{"name":"Manager Mode"},{"name":"Logical Switches"},{"name":"Users"},{"name":"Sessions"},{"name":"Bridge Endpoints"},{"name":"NS Service Groups"},{"name":"Manager Configuration"},{"name":"Failure Domains"},{"name":"Async Replicator Service"},{"name":"VPN"},{"name":"Normalization"},{"name":"Cm Inventory Service"},{"name":"Transport Zones"},{"name":"Intrusion Services"},{"name":"Logical Routing And Services"},{"name":"Mandatory Access Control"},{"name":"Node Stats Service"},{"name":"Container Clusters"},{"name":"Authentication Policy"},{"name":"Customer Experience Improvement"},{"name":"IP Sets"},{"name":"System Administration"},{"name":"Domains"},{"name":"L2VPN"},{"name":"Livetrace"},{"name":"API Request Batching"},{"name":"Federation"},{"name":"Restore"},{"name":"Eula"},{"name":"Pool Management"},{"name":"MAC Pools"},{"name":"Compute Managers"},{"name":"Cloud Native Service Instances"},{"name":"L2VPN Remote MACS"},{"name":"Inter-Sites"},{"name":"Licenses"},{"name":"DPD Profiles"},{"name":"Controller Service"}]}